API Evangelist conversational phrasing for Live Direct Marketing Online Sequences API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Sequences API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-sequences-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/api/sequences'].get
  update:
    x-apievangelist-phrasing:
      intent: List email sequences
      effect: read
      questions:
      - What email sequences do I have set up?
      - Can I search my sequences by name and filter to only the active ones?
      instructions:
      - text: List my email sequences with status {status}.
        slots:
          status: query.status
      - text: Find sequences matching {search}, page {page} at {pageSize} per page.
        slots:
          search: query.search
          page: query.page
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email sequence
      effect: write
      questions:
      - How do I build a new multi-step email sequence?
      - Can I start a fresh outreach sequence from scratch?
      instructions:
      - text: Create a new email sequence.
      - text: Set up a blank outreach sequence for me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email sequence
      effect: read
      questions:
      - What steps and settings does one of my sequences have?
      - Where can I view a single email sequence in full?
      instructions:
      - text: Show sequence {id}.
        slots:
          id: path.id
      - text: Fetch the full definition of email sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email sequence
      effect: destructive
      questions:
      - How do I permanently remove an email sequence?
      - Can I delete a sequence I no longer use?
      instructions:
      - text: Delete sequence {id}.
        slots:
          id: path.id
      - text: Remove email sequence {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an email sequence
      effect: write
      questions:
      - Can I rename or change the status of an existing sequence?
      - What do I call to edit a sequence's settings?
      instructions:
      - text: Update sequence {id}.
        slots:
          id: path.id
      - text: Edit the settings of email sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a step to an email sequence
      effect: write
      questions:
      - How do I add another follow-up email to a sequence?
      - Can I append a new step to an existing sequence?
      instructions:
      - text: Add a step to sequence {id}.
        slots:
          id: path.id
      - text: Append a new follow-up email step to sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps/{stepId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a step from an email sequence
      effect: destructive
      questions:
      - Can I remove one follow-up email from a sequence?
      - How do I drop a step out of my sequence?
      instructions:
      - text: Delete step {stepId} from sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      - text: Remove sequence step {stepId} in sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps/{stepId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a step in an email sequence
      effect: write
      questions:
      - How do I change the content or delay of one sequence step?
      - Can I edit a single step without rebuilding the whole sequence?
      instructions:
      - text: Update step {stepId} of sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      - text: Edit sequence step {stepId} in sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps/{stepId}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List A/B variants on a sequence step
      effect: read
      questions:
      - Which A/B variants am I testing on a sequence step?
      - What versions of one email step exist for split testing?
      instructions:
      - text: List the A/B variants on step {stepId} of sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      - text: Show all split-test versions of step {stepId} in sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps/{stepId}/variants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an A/B variant to a sequence step
      effect: write
      questions:
      - How do I A/B test a different subject line on a sequence step?
      - Can I add a second version of an email to split test?
      instructions:
      - text: Add an A/B variant to step {stepId} of sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      - text: Create a new split-test version for sequence {id} step {stepId}.
        slots:
          id: path.id
          stepId: path.stepId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps/{stepId}/variants/{variantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an A/B variant
      effect: destructive
      questions:
      - Can I remove a losing A/B variant from a step?
      - How do I delete one split-test version of an email?
      instructions:
      - text: Delete variant {variantId} on step {stepId} of sequence {id}.
        slots:
          variantId: path.variantId
          stepId: path.stepId
          id: path.id
      - text: Remove A/B variant {variantId} from sequence {id} step {stepId}.
        slots:
          variantId: path.variantId
          id: path.id
          stepId: path.stepId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps/{stepId}/variants/{variantId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an A/B variant
      effect: write
      questions:
      - How do I edit the copy of one A/B variant?
      - Can I tweak a split-test version without deleting it?
      instructions:
      - text: Update variant {variantId} on step {stepId} of sequence {id}.
        slots:
          variantId: path.variantId
          stepId: path.stepId
          id: path.id
      - text: Edit A/B variant {variantId} in sequence {id} step {stepId}.
        slots:
          variantId: path.variantId
          id: path.id
          stepId: path.stepId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/steps/{stepId}/variants/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare A/B variant performance on a step
      effect: read
      questions:
      - Which A/B variant on my sequence step is winning?
      - What are the results of the split test on one email step?
      instructions:
      - text: Show A/B variant statistics for step {stepId} of sequence {id}.
        slots:
          stepId: path.stepId
          id: path.id
      - text: Compare how the variants of sequence {id} step {stepId} are performing.
        slots:
          id: path.id
          stepId: path.stepId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/enroll'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll contacts into an email sequence
      effect: write
      questions:
      - How do I add contacts to an email sequence so they start receiving it?
      - Can I enroll a batch of leads into a sequence?
      instructions:
      - text: Enroll contacts into sequence {id}.
        slots:
          id: path.id
      - text: Start sending email sequence {id} to a new set of contacts.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/{id}/enrollments'].get
  update:
    x-apievangelist-phrasing:
      intent: List enrollments in an email sequence
      effect: read
      questions:
      - Who is currently enrolled in my sequence?
      - Can I list only the paused enrollments of a sequence?
      instructions:
      - text: List enrollments in sequence {id} with status {status}.
        slots:
          id: path.id
          status: query.status
      - text: Show page {page} of sequence {id}'s enrollments, {pageSize} per page.
        slots:
          page: query.page
          id: path.id
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/enrollments/{eid}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause one contact's sequence enrollment
      effect: write
      questions:
      - Can I pause a sequence for just one contact?
      - How do I hold off further emails to a single enrolled contact?
      instructions:
      - text: Pause enrollment {eid}.
        slots:
          eid: path.eid
      - text: Stop sending sequence emails to enrollment {eid} for now.
        slots:
          eid: path.eid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/enrollments/{eid}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused sequence enrollment
      effect: write
      questions:
      - How do I restart emails to a contact whose enrollment I paused?
      - Can a paused enrollment pick up where it left off?
      instructions:
      - text: Resume enrollment {eid}.
        slots:
          eid: path.eid
      - text: Continue the paused sequence for enrollment {eid}.
        slots:
          eid: path.eid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sequences/enrollments/{eid}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a sequence enrollment
      effect: destructive
      questions:
      - How do I take a contact out of a sequence entirely?
      - Can I cancel an enrollment so no more steps are sent?
      instructions:
      - text: Cancel enrollment {eid}.
        slots:
          eid: path.eid
      - text: Remove enrollment {eid} from its sequence permanently.
        slots:
          eid: path.eid
      method: generated
      generated: '2026-10-01'