# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Automations API
  version: 1.0.0
extends: openapi/omnisend-automations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 13
- target: $.paths['/automations'].get
  update:
    x-apievangelist-phrasing:
      intent: List automation workflows
      effect: read
      questions:
      - Which of my automation workflows are currently enabled?
      - Can I find automation workflows whose name contains a certain word?
      - What automations were created or changed during a given date range?
      instructions:
      - text: List automation workflows whose name contains {nameContains}.
        slots:
          nameContains: query.nameContains
      - text: List automation workflows with enabled status {isEnabled}.
        slots:
          isEnabled: query.isEnabled
      - text: List automation workflows created between {createdAtFrom} and {createdAtTo}.
        slots:
          createdAtFrom: query.createdAtFrom
          createdAtTo: query.createdAtTo
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an automation workflow
      effect: write
      questions:
      - 'What do I need to build a brand-new automation workflow: a trigger, blocks and a name?'
      - Can I set exit conditions when I first create an automation flow?
      instructions:
      - text: Create a new automation workflow named {name} triggered by {trigger} with blocks {blocks}.
        slots:
          name: requestBody.name
          trigger: requestBody.trigger
          blocks: requestBody.blocks
      - text: Build a new automation {name} on trigger {trigger} with blocks {blocks} and exit conditions {exitConditions}.
        slots:
          name: requestBody.name
          trigger: requestBody.trigger
          blocks: requestBody.blocks
          exitConditions: requestBody.exitConditions
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one automation workflow
      effect: read
      questions:
      - What trigger and blocks does one specific automation workflow have?
      - Can I look up a single automation workflow's details by its ID?
      instructions:
      - text: Show me automation workflow {id}.
        slots:
          id: path.id
      - text: Fetch the trigger, settings and blocks of automation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an automation workflow
      effect: destructive
      questions:
      - Can I permanently remove an automation workflow I no longer use?
      - What happens if I try to delete an automation workflow that is already gone?
      instructions:
      - text: Delete automation workflow {id}.
        slots:
          id: path.id
      - text: Remove the old automation {id} from my account for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit fields of an automation workflow
      effect: write
      questions:
      - Why can't I edit an automation workflow while it is enabled?
      - Can I rename an automation or change its trigger without resending every field?
      instructions:
      - text: Rename automation workflow {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the trigger of disabled automation {id} to {trigger}.
        slots:
          id: path.id
          trigger: requestBody.trigger
      - text: Update the exit conditions on automation {id} to {exitConditions}.
        slots:
          id: path.id
          exitConditions: requestBody.exitConditions
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/blocks'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an automation's full block tree
      effect: write
      questions:
      - How do I replace the whole block tree of an automation flow in one call?
      - Will blocks I leave out of the new block list be removed from the workflow?
      instructions:
      - text: Replace the entire block tree of automation {id} with {blocks}.
        slots:
          id: path.id
          blocks: requestBody.blocks
      - text: 'Restructure the steps of disabled automation {id} using this complete block list: {blocks}.'
        slots:
          id: path.id
          blocks: requestBody.blocks
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/blocks/{blockID}/test-email'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test of an automation email block
      effect: write
      questions:
      - Can I preview one email step of an automation by sending it to my inbox?
      - How many recipients can receive a test of an automation email block?
      instructions:
      - text: Send a test of email block {blockID} in automation {id} to {recipients}.
        slots:
          blockID: path.blockID
          id: path.id
          recipients: requestBody.recipients
      - text: Email the saved content of automation {id} step {blockID} to {recipients} as a test.
        slots:
          id: path.id
          blockID: path.blockID
          recipients: requestBody.recipients
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/blocks/{blockID}/utm'].get
  update:
    x-apievangelist-phrasing:
      intent: Get UTM tags for one automation block
      effect: read
      questions:
      - What UTM tags are set on a single send step of my automation?
      - Which default UTM values apply to an automation block where I never set tags?
      instructions:
      - text: Show the UTM tags for block {blockID} of automation {id}.
        slots:
          blockID: path.blockID
          id: path.id
      - text: Get the three UTM tag values for send block {blockID} in workflow {id}.
        slots:
          blockID: path.blockID
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/blocks/{blockID}/utm'].put
  update:
    x-apievangelist-phrasing:
      intent: Set UTM tags for one automation block
      effect: write
      questions:
      - Can I change UTM tracking tags on just one email step of an automation?
      - How do I clear a UTM field on an automation block so it falls back to the default?
      instructions:
      - text: Set the UTM tags on block {blockID} of automation {id} to {tags}.
        slots:
          blockID: path.blockID
          id: path.id
          tags: requestBody.tags
      - text: Overwrite the UTM tracking on send block {blockID} in workflow {id} with {tags}.
        slots:
          blockID: path.blockID
          id: path.id
          tags: requestBody.tags
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an automation workflow
      effect: write
      questions:
      - Can I duplicate an automation workflow and give the copy its own name?
      - Is a copied automation turned on automatically, or does it start disabled?
      instructions:
      - text: Copy automation {id} and name the copy {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Duplicate automation workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off an automation workflow
      effect: write
      questions:
      - Can I turn off an automation but let contacts already in it finish the flow?
      - Is there a way to stop a workflow and immediately remove everyone currently in it?
      instructions:
      - text: Disable automation {id}, handling contacts already in it as {contactsInWorkflow}.
        slots:
          id: path.id
          contactsInWorkflow: requestBody.contactsInWorkflow
      - text: Stop automation {id} from accepting new triggers with contactsInWorkflow set to {contactsInWorkflow}.
        slots:
          id: path.id
          contactsInWorkflow: requestBody.contactsInWorkflow
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on an automation workflow
      effect: write
      questions:
      - Can I turn on an automation and also enroll contacts who already qualify?
      - Does enabling a workflow only process future trigger events by default?
      instructions:
      - text: Enable automation {id}.
        slots:
          id: path.id
      - text: Turn on automation {id} with enroll-existing-contacts set to {enrollExisting}.
        slots:
          id: path.id
          enrollExisting: requestBody.enrollExisting
      method: generated
      generated: '2026-10-02'
- target: $.paths['/automations/{id}/utm'].get
  update:
    x-apievangelist-phrasing:
      intent: Get UTM tags for all blocks in an automation
      effect: read
      questions:
      - Can I see the UTM tags for every send step of an automation at once?
      - What UTM tracking does each message block in my workflow use?
      instructions:
      - text: List UTM tags for all send blocks in automation {id}.
        slots:
          id: path.id
      - text: Show the aggregated UTM settings across every message step of workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'