# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kit Sequences API
  version: 1.0.0
extends: openapi/convertkit-sequences-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v4/sequences'].get
  update:
    x-apievangelist-phrasing:
      intent: List sequences
      effect: read
      questions:
      - What automated email sequences do I have?
      - Can I page through every sequence on my account?
      instructions:
      - text: List all my email sequences.
      - text: Show my sequences, {per_page} per page.
        slots:
          per_page: query.per_page
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an empty sequence
      effect: write
      questions:
      - How do I start a new automated email sequence?
      - Can I set the send days and hour when creating a sequence?
      instructions:
      - text: Create a new sequence named {name}.
        slots:
          name: requestBody.name
      - text: Create sequence {name} that sends at hour {send_hour} in time zone {time_zone}.
        slots:
          name: requestBody.name
          send_hour: requestBody.send_hour
          time_zone: requestBody.time_zone
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sequence's settings
      effect: read
      questions:
      - What schedule and sending address is a specific sequence using?
      - Is a particular sequence active, and does it let subscribers repeat it?
      instructions:
      - text: Get sequence {id}.
        slots:
          id: path.id
      - text: Show the schedule and flags configured on sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sequence's settings
      effect: write
      questions:
      - How do I pause or reactivate an existing sequence?
      - Can I change which days of the week a sequence sends on?
      instructions:
      - text: Set active to {active} on sequence {id}.
        slots:
          active: requestBody.active
          id: path.id
      - text: Rename existing sequence {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change sequence {id} to send only on {send_days}.
        slots:
          id: path.id
          send_days: requestBody.send_days
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sequence
      effect: destructive
      questions:
      - What happens to active subscribers if I delete a whole sequence?
      - Can I remove an entire automated sequence I no longer use?
      instructions:
      - text: Delete sequence {id}.
        slots:
          id: path.id
      - text: Remove the entire sequence {id} from delivery.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{sequence_id}/subscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers in a sequence
      effect: read
      questions:
      - Who is currently enrolled in a given sequence?
      - Can I see which sequence subscribers were added after a certain date?
      instructions:
      - text: List subscribers in sequence {sequence_id}.
        slots:
          sequence_id: path.sequence_id
      - text: Show subscribers added to sequence {sequence_id} after {added_after}.
        slots:
          sequence_id: path.sequence_id
          added_after: query.added_after
      - text: List sequence {sequence_id} subscribers whose status is {status}.
        slots:
          sequence_id: path.sequence_id
          status: query.status
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{sequence_id}/subscribers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a subscriber to a sequence by email
      effect: write
      questions:
      - How do I enroll someone in a sequence using their email address?
      - Does a person need to be a subscriber already before I add their email to a sequence?
      instructions:
      - text: Add {email_address} to sequence {sequence_id}.
        slots:
          email_address: requestBody.email_address
          sequence_id: path.sequence_id
      - text: Enroll the subscriber with email {email_address} in sequence {sequence_id}.
        slots:
          email_address: requestBody.email_address
          sequence_id: path.sequence_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{sequence_id}/subscribers/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a subscriber to a sequence by id
      effect: write
      questions:
      - Can I enroll a subscriber in a sequence using their subscriber id instead of email?
      - What's needed to put a known subscriber id into an automated sequence?
      instructions:
      - text: Add subscriber id {id} to sequence {sequence_id}.
        slots:
          id: path.id
          sequence_id: path.sequence_id
      - text: Enroll subscriber {id} in sequence {sequence_id} by their id.
        slots:
          id: path.id
          sequence_id: path.sequence_id
      method: generated
      generated: '2026-10-02'