# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lemlist Sequences API
  version: 1.0.0
extends: openapi/lemlist-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: 9
- target: $.paths['/campaigns/{campaignId}/sequences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's sequences and steps
      effect: read
      questions:
      - What steps make up a campaign's outreach sequence?
      - Where do I find the sequence id for a campaign?
      instructions:
      - text: Show the sequences of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: List every step in campaign {campaignId}'s sequence.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a step to a sequence
      effect: write
      questions:
      - How do I add another follow-up step to a sequence?
      - Can I append a new email or LinkedIn step to an existing campaign sequence?
      instructions:
      - text: Add a step to sequence {sequenceId}.
        slots:
          sequenceId: path.sequenceId
      - text: Append a new follow-up step to sequence {sequenceId}.
        slots:
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps/{stepId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a step from a sequence
      effect: destructive
      questions:
      - Can I remove one step from a campaign's sequence?
      - How do I drop a follow-up I no longer want sent?
      instructions:
      - text: Delete step {stepId} from sequence {sequenceId}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      - text: Remove follow-up step {stepId} in sequence {sequenceId}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps/{stepId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a sequence step
      effect: write
      questions:
      - How do I change the content or delay of an existing step?
      - Can I edit a step's email after the sequence is built?
      instructions:
      - text: Update step {stepId} in sequence {sequenceId}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      - text: Edit the main content of step {stepId} of sequence {sequenceId}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps/{stepId}/ab-test'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the B variant of an email A/B test
      effect: read
      questions:
      - What subject and message is variant B using in my A/B test?
      - Which plan do I need to view an email step's A/B test?
      instructions:
      - text: Show A/B variant B of step {stepId} in sequence {sequenceId}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      - text: Get the A/B test variant on email step {stepId} of {sequenceId}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps/{stepId}/ab-test'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an A/B test on an email step
      effect: write
      questions:
      - How do I split-test two versions of an email step?
      - Does a new A/B variant start as a copy of the original email?
      instructions:
      - text: Start an A/B test on step {stepId} of sequence {sequenceId}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      - text: Create variant B for email step {stepId} in {sequenceId} and split the leads.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps/{stepId}/ab-test'].delete
  update:
    x-apievangelist-phrasing:
      intent: End an A/B test by deleting a variant
      effect: destructive
      questions:
      - How do I stop an A/B test and keep only one version?
      - What happens if I delete variant A instead of B?
      instructions:
      - text: End the A/B test on step {stepId} of sequence {sequenceId} by dropping variant B.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
      - text: Delete variant {variant} of the A/B test on step {stepId} in {sequenceId}.
        slots:
          variant: query.variant
          stepId: path.stepId
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps/{stepId}/ab-test'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit variant B of an A/B test
      effect: write
      questions:
      - Can I change the subject line of my A/B test's B version?
      - How long can the variant B subject be?
      instructions:
      - text: Set variant B's subject on step {stepId} of {sequenceId} to {subject}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
          subject: requestBody.subject
      - text: Replace the variant B body of A/B step {stepId} in {sequenceId} with {message}.
        slots:
          stepId: path.stepId
          sequenceId: path.sequenceId
          message: requestBody.message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/{sequenceId}/steps/{stepId}/ab-test/winner'].post
  update:
    x-apievangelist-phrasing:
      intent: Pick the winner of an A/B test
      effect: write
      questions:
      - How do I declare a winning version so remaining leads get it?
      - Once I choose an A/B winner, who receives that template?
      instructions:
      - text: Pick variant {variant} as the A/B winner on step {stepId} of {sequenceId}.
        slots:
          variant: requestBody.variant
          stepId: path.stepId
          sequenceId: path.sequenceId
      - text: Send variant {variant} to all remaining leads for step {stepId} in {sequenceId}.
        slots:
          variant: requestBody.variant
          stepId: path.stepId
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-10-01'