# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for WhatsApp Flows API
  version: 1.0.0
extends: openapi/activecampaign-flows-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/channel/whatsapp/flow-execution'].get
  update:
    x-apievangelist-phrasing:
      intent: List WhatsApp flow runs
      effect: read
      questions:
      - Which WhatsApp flows have been run and when?
      - Can I see the executions of a specific flow version?
      instructions:
      - text: List executions of flow {flow}.
        slots:
          flow: query.flow
      - text: Show runs of flow {flow} version {flow_version}.
        slots:
          flow: query.flow
          flow_version: query.flow_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/channel/whatsapp/flow-execution-contact'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts in WhatsApp flow runs
      effect: read
      questions:
      - Which contacts are currently active in a WhatsApp flow?
      - Can I see which contacts reached a certain step of a flow run?
      instructions:
      - text: List contacts in flow execution {flow_execution}.
        slots:
          flow_execution: query.flow_execution
      - text: Show where contact {contact} is in WhatsApp flows.
        slots:
          contact: query.contact
      - text: List contacts that reached step {step_id}.
        slots:
          step_id: query.execution_steps__step_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/channel/whatsapp/flow-execution-contact/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one contact's WhatsApp flow run
      effect: read
      questions:
      - Where do I see a single contact's progress through a flow run?
      - What steps has one flow execution contact record completed?
      instructions:
      - text: Show flow execution contact {id}.
        slots:
          id: path.id
      - text: Get the progress of flow execution contact record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/channel/whatsapp/flow-execution/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a WhatsApp flow run
      effect: read
      questions:
      - Where can I check the details of one flow execution?
      - What happened in WhatsApp flow run 15?
      instructions:
      - text: Show flow execution {id}.
        slots:
          id: path.id
      - text: Get the status of WhatsApp flow run {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/channel/whatsapp/flow/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a WhatsApp flow for contacts
      effect: write
      questions:
      - How do I start a WhatsApp flow for a list of contacts?
      - Can I run a flow with priority over other executions?
      instructions:
      - text: Run flow {id} for {execute_for} using contact list {contact_list}.
        slots:
          id: path.id
          execute_for: requestBody.execute_for
          contact_list: requestBody.contact_list
      - text: Start WhatsApp flow {id} for {execute_for}, list {contact_list}, with priority {has_priority}.
        slots:
          id: path.id
          execute_for: requestBody.execute_for
          contact_list: requestBody.contact_list
          has_priority: requestBody.has_priority
      method: generated
      generated: '2026-09-26'