Kit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kit Sequence Emails API

6 actions 6 updates phrasing extends openapi/convertkit-sequence-emails-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Kit's API. It is a proposal applied on top of the contract, not a document Kit publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v4/sequences/{sequence_id}/emails'].get

$.paths['/v4/sequences/{sequence_id}/emails'].post

$.paths['/v4/sequences/{sequence_id}/emails/{id}'].get

$.paths['/v4/sequences/{sequence_id}/emails/{id}'].put

$.paths['/v4/sequences/{sequence_id}/emails/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kit Sequence Emails API
  version: 1.0.0
extends: openapi/convertkit-sequence-emails-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: 5
- target: $.paths['/v4/sequences/{sequence_id}/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List the emails in a sequence
      effect: read
      questions:
      - What emails are in my welcome sequence and in what order?
      - Can I see the delay and publish state of every email in a sequence?
      - Is the HTML content returned when listing a sequence's emails?
      instructions:
      - text: List the emails in sequence {sequence_id}.
        slots:
          sequence_id: path.sequence_id
      - text: Show every email in sequence {sequence_id} with content included set to {include_content}.
        slots:
          sequence_id: path.sequence_id
          include_content: query.include_content
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{sequence_id}/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email to a sequence
      effect: write
      questions:
      - How do I add a new email step to an automated sequence?
      - Can I set a new sequence email to send a few days after the previous one?
      - Will a newly added sequence email be a draft by default?
      instructions:
      - text: Add an email with subject {subject} to sequence {sequence_id}, sent {delay_value} {delay_unit} after the previous one.
        slots:
          subject: requestBody.subject
          sequence_id: path.sequence_id
          delay_value: requestBody.delay_value
          delay_unit: requestBody.delay_unit
      - text: Create email {subject} in sequence {sequence_id} with a {delay_value} {delay_unit} delay and published set to {published}.
        slots:
          subject: requestBody.subject
          sequence_id: path.sequence_id
          delay_value: requestBody.delay_value
          delay_unit: requestBody.delay_unit
          published: requestBody.published
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{sequence_id}/emails/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sequence email with its content
      effect: read
      questions:
      - Can I fetch the full HTML of a single email inside a sequence?
      - What subject, delay and send days are set on one particular sequence email?
      instructions:
      - text: Get email {id} from sequence {sequence_id}.
        slots:
          id: path.id
          sequence_id: path.sequence_id
      - text: Show me the full content of sequence {sequence_id} email {id}.
        slots:
          id: path.id
          sequence_id: path.sequence_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{sequence_id}/emails/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sequence email
      effect: write
      questions:
      - How do I publish a draft email inside a sequence?
      - Can I change the delay or reorder an existing sequence email?
      instructions:
      - text: Change the subject of email {id} in sequence {sequence_id} to {subject}.
        slots:
          id: path.id
          sequence_id: path.sequence_id
          subject: requestBody.subject
      - text: Set published to {published} on email {id} of sequence {sequence_id}.
        slots:
          published: requestBody.published
          id: path.id
          sequence_id: path.sequence_id
      - text: Move sequence {sequence_id} email {id} to position {position}.
        slots:
          sequence_id: path.sequence_id
          id: path.id
          position: requestBody.position
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/sequences/{sequence_id}/emails/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email from a sequence
      effect: destructive
      questions:
      - What happens to queued subscribers if I delete one email from a sequence?
      - Can I permanently remove a single step from an automated sequence?
      instructions:
      - text: Delete email {id} from sequence {sequence_id}.
        slots:
          id: path.id
          sequence_id: path.sequence_id
      - text: Permanently remove step {id} from sequence {sequence_id}.
        slots:
          id: path.id
          sequence_id: path.sequence_id
      method: generated
      generated: '2026-10-02'