# 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-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: 3
- target: $.paths['/interaction/v1/interactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Journey Builder journeys
      effect: read
      questions:
      - Which Journey Builder journeys do we have in Marketing Cloud?
      - Can I list only the journeys that are currently published?
      instructions:
      - text: List journeys with status {status}.
        slots:
          status: query.status
      - text: Show page {page} of our journeys, {pageSize} at a time.
        slots:
          page: query.page
          pageSize: query.pageSize
      - text: List all our marketing journeys.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/interactions/{interactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey's details
      effect: read
      questions:
      - What activities, triggers and goals make up a given journey?
      - Can I look at an older version of a journey?
      instructions:
      - text: Get journey {interactionId}.
        slots:
          interactionId: path.interactionId
      - text: Show version {versionNumber} of journey {interactionId}.
        slots:
          versionNumber: query.versionNumber
          interactionId: path.interactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interaction/v1/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Enter a contact into a journey
      effect: write
      questions:
      - How do I push a contact into a journey from my own app?
      - Can I pass extra data with the entry event to personalize the journey?
      instructions:
      - text: Enter contact {ContactKey} into the journey via event {EventDefinitionKey}.
        slots:
          ContactKey: requestBody.ContactKey
          EventDefinitionKey: requestBody.EventDefinitionKey
      - text: Fire entry event {EventDefinitionKey} for {ContactKey} with data {Data}.
        slots:
          EventDefinitionKey: requestBody.EventDefinitionKey
          ContactKey: requestBody.ContactKey
          Data: requestBody.Data
      method: generated
      generated: '2026-09-26'