# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Sequences API
  version: 1.0.0
extends: openapi/close-sequences-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/sequence/'].get
  update:
    x-apievangelist-phrasing:
      intent: List email sequences
      effect: read
      questions:
      - What sequences have we set up for automated outreach?
      - Can I page through all of our sales sequences a batch at a time?
      instructions:
      - text: List all of our sequences.
      - text: Show the first {limit} sequences.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an outreach sequence
      effect: write
      questions:
      - How do I build a new multi-step outreach sequence in Close?
      - Can I set up a new automated follow-up sequence through the API?
      instructions:
      - text: Create a new sequence for our cold outreach campaign.
      - text: Set up a new follow-up sequence with email steps.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sequence's details
      effect: read
      questions:
      - Which steps are in a particular sequence?
      - Where can I see the configuration of a single sequence?
      instructions:
      - text: Show me sequence {id}.
        slots:
          id: path.id
      - text: Fetch the steps and settings of sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sequence's steps or settings
      effect: write
      questions:
      - If I leave out steps when editing a sequence, are they removed?
      - How do I rename or change the steps of an existing sequence?
      instructions:
      - text: Rename sequence {id}.
        slots:
          id: path.id
      - text: Replace the steps of sequence {id} with the new step list.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sequence
      effect: destructive
      questions:
      - Can I permanently remove a sequence we no longer use?
      - What happens when I delete an outreach sequence?
      instructions:
      - text: Delete sequence {id}.
        slots:
          id: path.id
      - text: Remove the retired sequence {id} from our account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence_subscription/'].get
  update:
    x-apievangelist-phrasing:
      intent: List who is subscribed to sequences
      effect: read
      questions:
      - Which contacts are currently enrolled in a given sequence?
      - What sequences is a particular lead subscribed to?
      - Do I need a sequence, contact or lead filter to list subscriptions?
      instructions:
      - text: List the subscriptions for sequence {sequence_id}.
        slots:
          sequence_id: query.sequence_id
      - text: Show which sequences contact {contact_id} is enrolled in.
        slots:
          contact_id: query.contact_id
      - text: List sequence subscriptions for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence_subscription/'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a contact in a sequence
      effect: write
      questions:
      - How do I add a single contact to an outreach sequence?
      - Can I start one contact on a sequence from my own app?
      instructions:
      - text: Subscribe this contact to our onboarding sequence.
      - text: Enroll a contact in a sequence so the first step starts sending.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence_subscription/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sequence subscription
      effect: read
      questions:
      - How can I check the status of one contact's sequence enrollment?
      - Where do I see details of a specific sequence subscription?
      instructions:
      - text: Show sequence subscription {id}.
        slots:
          id: path.id
      - text: Fetch the details of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence_subscription/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sequence subscription
      effect: write
      questions:
      - Can I pause or change an existing sequence enrollment?
      - How do I modify a contact's subscription to a sequence?
      instructions:
      - text: Update sequence subscription {id}.
        slots:
          id: path.id
      - text: Pause the sequence subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sequence_subscription/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a contact from a sequence
      effect: destructive
      questions:
      - How do I take a contact out of a sequence?
      - Is deleting a subscription the way to unsubscribe someone from a sequence?
      instructions:
      - text: Unsubscribe the contact on subscription {id} from its sequence.
        slots:
          id: path.id
      - text: Delete sequence subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'