# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Workflows API
  version: 1.0.0
extends: openapi/iterable-workflows-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: 3
- target: $.paths['/api/journeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List journeys
      effect: read
      questions:
      - What journeys exist in my project?
      - Can I filter journeys by state and page through them?
      instructions:
      - text: List my journeys.
      - text: List journeys in state {state}, page {page} with {pageSize} per page.
        slots:
          state: query.state
          page: query.page
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/workflows/triggerWorkflow'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a journey for a user or list
      effect: write
      questions:
      - How do I start a journey for one user under /api/workflows?
      - Can I trigger a journey for an entire list, and is that asynchronous?
      instructions:
      - text: Trigger journey {workflowId} for {email}.
        slots:
          workflowId: requestBody.workflowId
          email: requestBody.email
      - text: Trigger journey {workflowId} for list {listId} via /api/workflows.
        slots:
          workflowId: requestBody.workflowId
          listId: requestBody.listId
      - text: Start journey {workflowId} for user {userId} with data {dataFields}.
        slots:
          workflowId: requestBody.workflowId
          userId: requestBody.userId
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workflows/triggerWorkflow'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll users in a workflow (simple)
      effect: write
      questions:
      - Is there a plain /workflows/triggerWorkflow call to enroll users in an activated workflow?
      - Does the workflow need to be activated before I enroll someone?
      instructions:
      - text: Using /workflows/triggerWorkflow, enroll {email} in workflow {workflowId}.
        slots:
          email: requestBody.email
          workflowId: requestBody.workflowId
      - text: Enroll list {listId} in workflow {workflowId} with the simple endpoint.
        slots:
          listId: requestBody.listId
          workflowId: requestBody.workflowId
      method: generated
      generated: '2026-10-01'