API Evangelist conversational phrasing for Unify 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 Unify Sequences API
  version: 1.0.0
extends: openapi/unify-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: 23
- target: $.paths['/sequences/v1/enrollment-steps/query-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List enrollment step export jobs
      effect: read
      questions:
      - Which per-step sequence activity exports have I started?
      - Can I filter enrollment step export jobs by status?
      instructions:
      - text: List my enrollment step export jobs.
      - text: Show enrollment step export jobs with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollment-steps/query-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk export of sequence step activity
      effect: write
      questions:
      - How do I export email opens and replies for every step each person went through in my sequences?
      - Can I export only some enrollment steps using a filter?
      instructions:
      - text: Start an export of all sequence enrollment steps.
      - text: Start an enrollment step export filtered by {filter}.
        slots:
          filter: requestBody.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollment-steps/query-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an enrollment step export
      effect: read
      questions:
      - Is my sequence step activity export finished yet?
      - When does an enrollment step export job expire?
      instructions:
      - text: Check the status of enrollment step export {job_id}.
        slots:
          job_id: path.job_id
      - text: Poll step activity export job {job_id} until it finishes.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollment-steps/query-jobs/{job_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running enrollment step export
      effect: destructive
      questions:
      - Can I stop a sequence step activity export that is still running?
      - Is it possible to cancel an enrollment step export after it has finished?
      instructions:
      - text: Cancel enrollment step export job {job_id}.
        slots:
          job_id: path.job_id
      - text: Stop the in-progress step activity export {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollment-steps/query-jobs/{job_id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Download results of an enrollment step export
      effect: read
      questions:
      - How do I page through the per-step email engagement rows from a finished export?
      - Can I stream enrollment step export results as NDJSON?
      instructions:
      - text: Fetch the exported enrollment steps from job {job_id}.
        slots:
          job_id: path.job_id
      - text: Get page {page} of step activity export {job_id} with {page_size} rows.
        slots:
          page: query.page
          job_id: path.job_id
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments'].get
  update:
    x-apievangelist-phrasing:
      intent: List sequence enrollments
      effect: read
      questions:
      - Who is currently enrolled in a given sequence and how far along are they?
      - Which enrollments have replied, bounced or opted out recently?
      - Can I see which sequences one person is enrolled in?
      instructions:
      - text: List enrollments in sequence {sequence_id}.
        slots:
          sequence_id: query.sequence_id
      - text: Show enrollments for person {person_id} with status {status}.
        slots:
          person_id: query.person_id
          status: query.status
      - text: List enrollments updated after {updated_after} that were created by play {enrolled_by_play_id}.
        slots:
          updated_after: query.updated_after
          enrolled_by_play_id: query.enrolled_by_play_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a person in a sequence
      effect: write
      questions:
      - How do I add a prospect to an outreach sequence?
      - What happens if I enroll someone who is already active in another sequence?
      - How many sending mailboxes can I offer when enrolling a person?
      instructions:
      - text: Enroll person {person_id} in sequence {sequence_id} sending from {mailbox_emails}.
        slots:
          person_id: requestBody.person_id
          sequence_id: requestBody.sequence_id
          mailbox_emails: requestBody.mailbox_emails
      - text: Add {person_id} to sequence {sequence_id} using one of mailboxes {mailbox_emails}.
        slots:
          person_id: requestBody.person_id
          sequence_id: requestBody.sequence_id
          mailbox_emails: requestBody.mailbox_emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/query-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List enrollment export jobs
      effect: read
      questions:
      - Which bulk sequence enrollment exports have I run?
      - Can I see only enrollment export jobs that are still in progress?
      instructions:
      - text: List my sequence enrollment export jobs.
      - text: Filter my bulk sequence enrollment exports to status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/query-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk export of sequence enrollments
      effect: write
      questions:
      - How do I export thousands of sequence enrollments at once?
      - Can a bulk enrollment export be limited by a filter?
      instructions:
      - text: Start an export of all sequence enrollments.
      - text: Start a sequence enrollment export filtered by {filter}.
        slots:
          filter: requestBody.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/query-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an enrollment export
      effect: read
      questions:
      - Has my bulk enrollment export finished yet?
      - How long do sequence enrollment export jobs last before expiring?
      instructions:
      - text: Check the status of enrollment export job {job_id}.
        slots:
          job_id: path.job_id
      - text: Poll sequence enrollment export {job_id} until it is finished.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/query-jobs/{job_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running enrollment export
      effect: destructive
      questions:
      - Can I stop a bulk sequence enrollment export that is running?
      - Which enrollment export jobs can still be canceled?
      instructions:
      - text: Cancel enrollment export job {job_id}.
        slots:
          job_id: path.job_id
      - text: Stop the running sequence enrollment export {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/query-jobs/{job_id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Download results of an enrollment export
      effect: read
      questions:
      - How do I page through the enrollments returned by a finished bulk export?
      - What is the maximum page size when downloading enrollment export results?
      instructions:
      - text: Fetch the exported enrollments from job {job_id}.
        slots:
          job_id: path.job_id
      - text: Get page {page} of enrollment export {job_id} with {page_size} rows.
        slots:
          page: query.page
          job_id: path.job_id
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sequence enrollment
      effect: read
      questions:
      - How do I check one person's progress in a sequence by enrollment ID?
      - Can I see whether a specific enrollment is paused or has a reply?
      instructions:
      - text: Get enrollment {id}.
        slots:
          id: path.id
      - text: Show the progress and status of sequence enrollment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a person's sequence enrollment
      effect: destructive
      questions:
      - How do I take someone out of a sequence so they get no more steps?
      - Can I stop all remaining emails to one enrolled person?
      instructions:
      - text: Cancel enrollment {id}.
        slots:
          id: path.id
      - text: Remove the person from their sequence by canceling enrollment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/{id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause one person's sequence enrollment
      effect: write
      questions:
      - Can I temporarily hold one prospect's outreach without affecting others in the sequence?
      - How do I pause a single enrollment?
      instructions:
      - text: Pause enrollment {id}.
        slots:
          id: path.id
      - text: Hold outreach for the person in enrollment {id} until I resume it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/enrollments/{id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused enrollment
      effect: write
      questions:
      - How do I restart outreach for one person whose enrollment I paused?
      - Can a paused enrollment pick up where it left off?
      instructions:
      - text: Resume enrollment {id}.
        slots:
          id: path.id
      - text: Continue the sequence for the person in paused enrollment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/sequences'].get
  update:
    x-apievangelist-phrasing:
      intent: List outreach sequences
      effect: read
      questions:
      - What outreach sequences exist in my Unify workspace?
      - Which automated email and task sequences can I enroll people in?
      instructions:
      - text: List all my sequences.
      - text: Show the first {limit} outreach sequences.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/sequences/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sequence
      effect: read
      questions:
      - Who owns a sequence and what send schedule does it use?
      - How can I view a sequence's ruleset?
      instructions:
      - text: Get sequence {id}.
        slots:
          id: path.id
      - text: Show the owner, schedule and ruleset of sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/sequences/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sequence
      effect: destructive
      questions:
      - How do I delete an outreach sequence I no longer use?
      - Can a whole sequence be removed by its ID?
      instructions:
      - text: Delete sequence {id}.
        slots:
          id: path.id
      - text: Permanently remove the outreach sequence {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/sequences/{id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause an entire sequence
      effect: write
      questions:
      - How do I halt a whole sequence for everyone enrolled in it?
      - Can I stop all sends from one sequence at once?
      instructions:
      - text: Pause sequence {id}.
        slots:
          id: path.id
      - text: Halt every enrollment in sequence {id} until I resume it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/sequences/{id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused sequence
      effect: write
      questions:
      - How do I restart a sequence I paused for all its enrollments?
      - Will enrollments continue once a paused sequence is turned back on?
      instructions:
      - text: Resume sequence {id}.
        slots:
          id: path.id
      - text: Turn paused sequence {id} back on for all its enrollments.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/sequences/{id}/steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List the steps of a sequence
      effect: read
      questions:
      - What emails, calls and LinkedIn touches make up a sequence?
      - Can I list only the automatic email steps of a sequence?
      instructions:
      - text: List the steps of sequence {id}.
        slots:
          id: path.id
      - text: Show steps of type {type} in sequence {id}.
        slots:
          type: query.type
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sequences/v1/sequences/{id}/steps/{step_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one step of a sequence
      effect: read
      questions:
      - How do I see the content and timing of a single sequence step?
      - When does a particular step run relative to the step before it?
      instructions:
      - text: Get step {step_id} of sequence {id}.
        slots:
          step_id: path.step_id
          id: path.id
      - text: Show the details of sequence {id} step {step_id}.
        slots:
          id: path.id
          step_id: path.step_id
      method: generated
      generated: '2026-10-01'