# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Marketing Cloud REST Journeys API
  version: 1.0.0
extends: openapi/salesforce-marketing-cloud-journeys-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: 8
- target: $.paths['/interaction/v1/interactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List journeys in Journey Builder
      effect: read
      questions:
      - Which journeys do I have in Marketing Cloud and what status is each one in?
      - Can I see only my stopped or draft journeys?
      - Is there a way to find a journey when I only remember part of its name?
      instructions:
      - text: List all my journeys sorted by most recently modified.
      - text: Show me every journey with status {status}.
        slots:
          status: query.status
      - text: Find journeys whose name or description contains {text}.
        slots:
          text: query.nameOrDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/interactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new journey
      effect: write
      questions:
      - How do I build a new customer journey through the API instead of Journey Builder's canvas?
      - Does a journey I create through the API start out as a draft?
      - What do I need to define the entry trigger and activities of a brand-new journey?
      instructions:
      - text: Create a new draft journey named {name} on Journey Builder API version {version}.
        slots:
          name: requestBody.name
          version: requestBody.workflowApiVersion
      - text: Set up a new journey called {name} with the description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/interactions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one journey's full definition
      effect: read
      questions:
      - How can I see the activities, goals and exit criteria configured in a specific journey?
      - Can I look at an earlier version of a journey rather than the latest one?
      instructions:
      - text: Get the full definition of journey {id}.
        slots:
          id: path.id
      - text: Show me version {version} of journey {id}.
        slots:
          version: query.versionNumber
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/interactions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing journey
      effect: write
      questions:
      - Can I change the activities of a journey that's still in draft?
      - How much of a published journey am I allowed to modify?
      - What happens to the triggers if I resend an existing journey's definition without them?
      instructions:
      - text: Rename existing journey {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Replace the definition of draft journey {id}, keeping the name {name} and API version {version}.
        slots:
          id: path.id
          name: requestBody.name
          version: requestBody.workflowApiVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/interactions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a journey
      effect: destructive
      questions:
      - Why can't I delete a journey that is currently running?
      - How do I permanently remove a journey I no longer need from Marketing Cloud?
      instructions:
      - text: Delete journey {id}.
        slots:
          id: path.id
      - text: Remove the stopped journey {id} from my account for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/interactions/publishAsync/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a journey so contacts can enter
      effect: write
      questions:
      - How do I activate a journey so contacts start entering it?
      - Can I choose which version of a journey goes live when I publish?
      - Is publishing a journey instant, or do I get a status id to track it?
      instructions:
      - text: Publish journey {id}.
        slots:
          id: path.id
      - text: Go live with version {version} of journey {id}.
        slots:
          version: requestBody.versionNumber
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/interactions/stop/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running journey
      effect: destructive
      questions:
      - How do I halt a published journey that's sending the wrong messages?
      - What happens to contacts who are mid-journey when I stop it?
      instructions:
      - text: Stop the published journey {id}.
        slots:
          id: path.id
      - text: Halt journey {id} so no more contacts move through it.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Inject a contact into a journey
      effect: write
      questions:
      - How do I push a single contact into a journey from my own app?
      - Can I pass extra data along when a contact enters a journey, for use in its emails?
      - Which event definition key do I need to trigger a journey's API entry source?
      instructions:
      - text: Add contact {contact} to the journey with entry event {event}.
        slots:
          contact: requestBody.ContactKey
          event: requestBody.EventDefinitionKey
      - text: Fire entry event {event} for contact {contact} with data {data}.
        slots:
          event: requestBody.EventDefinitionKey
          contact: requestBody.ContactKey
          data: requestBody.Data
      method: generated
      generated: '2026-09-26'