API Evangelist conversational phrasing for cdp-api Journeys API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for cdp-api Journeys API
  version: 1.0.0
extends: openapi/treasure-data-journeys-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: 32
- target: $.paths['/entities/journeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List journeys in a folder
      effect: read
      questions:
      - Which customer journeys are stored in a particular folder?
      - Can I list only the journeys I have a certain permission on within a folder?
      instructions:
      - text: List the journeys in folder {folder_id}.
        slots:
          folder_id: query.folder_id
      - text: List journeys in folder {folder_id} that I have {permission} permission on.
        slots:
          folder_id: query.folder_id
          permission: query.permission
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer journey
      effect: write
      questions:
      - What does it take to build a brand-new customer journey from scratch?
      - Can I attach a new journey to a folder when I create it?
      instructions:
      - text: Create a new journey with attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      - text: Create a journey with attributes {attributes} linked to {relationships}.
        slots:
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey's summary
      effect: read
      questions:
      - Where can I see the overall summary and setup of one journey?
      - What does a single journey look like when I fetch it by ID?
      instructions:
      - text: Show me the summary of journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Get the definition of journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a journey
      effect: destructive
      questions:
      - Can I permanently remove a journey I no longer need?
      - What happens when I delete a single journey entity?
      instructions:
      - text: Delete journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Remove the journey {journeyId} entirely.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a journey
      effect: write
      questions:
      - Can I rename a journey or change its settings after it is created?
      - Which journey attributes can be edited with a partial update?
      instructions:
      - text: Update journey {journeyId} with attributes {attributes}.
        slots:
          journeyId: path.journeyId
          attributes: requestBody.attributes
      - text: Patch the settings of journey {journeyId} to {attributes}.
        slots:
          journeyId: path.journeyId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/detail'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a draft journey's meta field
      effect: write
      questions:
      - Can I edit the meta details of a journey while it is still a draft?
      - Where do I save the stages and relationships of a draft journey?
      instructions:
      - text: Update the meta field of draft journey {journeyId} with {attributes} and {relationships}.
        slots:
          journeyId: path.journeyId
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      - text: Save draft details {attributes} on journey {journeyId}, keeping relationships {relationships}.
        slots:
          journeyId: path.journeyId
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/available_behaviors_for_step'].post
  update:
    x-apievangelist-phrasing:
      intent: List behavior tables available to a journey step
      effect: read
      questions:
      - Which behavior tables can I use in a given step of my journey?
      - What behavior data is available when configuring a journey step?
      instructions:
      - text: List the behavior tables available for step {stepId} of journey {journeyId}.
        slots:
          stepId: query.stepId
          journeyId: path.journeyId
      - text: Show which behaviors I can pick for a step in journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/activation_templates_for_step'].post
  update:
    x-apievangelist-phrasing:
      intent: List activation templates usable in a journey step
      effect: read
      questions:
      - Which activation templates can I apply to a step in my journey?
      - Are there saved activation templates available for a particular journey step?
      instructions:
      - text: List the activation templates available for step {stepId} of journey {journeyId}.
        slots:
          stepId: query.stepId
          journeyId: path.journeyId
      - text: Show the journey activation templates I can use in journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a journey
      effect: write
      questions:
      - Can I make a copy of an existing journey to start a new one?
      - Is there a way to clone a journey with all its stages?
      instructions:
      - text: Duplicate journey {id} as a new journey with attributes {attributes}.
        slots:
          id: requestBody.id
          attributes: requestBody.attributes
      - text: Make a copy of journey {id} of type {type} linked to {relationships} with attributes {attributes}.
        slots:
          id: requestBody.id
          type: requestBody.type
          relationships: requestBody.relationships
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey's statistics
      effect: read
      questions:
      - How many profiles have entered, converted or exited a specific journey?
      - Where can I find the performance numbers for one journey version?
      instructions:
      - text: Show the statistics for journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Get entry and conversion statistics of journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a journey workflow on demand
      effect: write
      questions:
      - How do I make a customer journey run immediately instead of waiting for its schedule?
      - Does triggering a journey on demand refresh the parent segment first?
      - Why would an on-demand journey run be rejected while a refresh is in progress?
      instructions:
      - text: Run journey {journeyId} now.
        slots:
          journeyId: path.journeyId
      - text: Trigger an on-demand execution of journey {journeyId} using the latest parent segment output.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/journeys/{journeyId}/conversion_sankey_charts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey's conversion sankey chart data
      effect: read
      questions:
      - Can I get the data behind the conversion flow diagram for a journey?
      - What source data drives the conversion sankey chart of one journey?
      instructions:
      - text: Get the conversion sankey chart data for journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Pull the conversion flow chart source for journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/activation_sankey_charts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey's activation sankey chart data
      effect: read
      questions:
      - Can I get the data behind the activation flow diagram for a journey?
      - What source data drives the activation sankey chart of one journey?
      instructions:
      - text: Get the activation sankey chart data for journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Pull the activation flow chart source for journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List profiles in a journey
      effect: read
      questions:
      - Which customer profiles are currently in a journey?
      - Can I see the people who are moving through a whole journey?
      instructions:
      - text: List the profiles in journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Show me every customer in journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/segment_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List journey segment rules in an audience
      effect: read
      questions:
      - Which journey-based segment rules can I use in a parent segment?
      - What segment rules do my viewable journeys expose for an audience?
      instructions:
      - text: List the journey segment rules available in audience {audience_id}.
        slots:
          audience_id: query.audience_id
      - text: Show segment rules from viewable journeys for parent segment {audience_id}.
        slots:
          audience_id: query.audience_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/activations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a journey's activation steps
      effect: read
      questions:
      - What activation steps are configured inside a journey?
      - Which destinations does a journey send profiles to?
      instructions:
      - text: List the activations in journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Show all activation steps of journey {journeyId}.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/activations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an activation step to a journey
      effect: write
      questions:
      - Can I add a new activation step that sends profiles out of a journey?
      - What do I need to create an activation node inside a journey?
      instructions:
      - text: Create activation step {id} in journey {journeyId} with attributes {attributes} and relationships {relationships}.
        slots:
          id: requestBody.id
          journeyId: path.journeyId
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      - text: Add an activation of type {type} to journey {journeyId} with attributes {attributes}, step {id}, linked to {relationships}.
        slots:
          type: requestBody.type
          journeyId: path.journeyId
          attributes: requestBody.attributes
          id: requestBody.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/activations/{journeyActivationStepId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activation step in a journey
      effect: read
      questions:
      - How is one particular activation node in my journey configured?
      - Can I look up a single journey activation step by its ID?
      instructions:
      - text: Show activation step {journeyActivationStepId} in journey {journeyId}.
        slots:
          journeyActivationStepId: path.journeyActivationStepId
          journeyId: path.journeyId
      - text: Get the summary of activation node {journeyActivationStepId} of journey {journeyId}.
        slots:
          journeyActivationStepId: path.journeyActivationStepId
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/activations/{journeyActivationStepId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an activation step in a journey
      effect: write
      questions:
      - Can I change the configuration of an activation step already in a journey?
      - What fields must I send to reconfigure a journey's activation node?
      instructions:
      - text: Update activation step {journeyActivationStepId} in journey {journeyId} with attributes {attributes}.
        slots:
          journeyActivationStepId: path.journeyActivationStepId
          journeyId: path.journeyId
          attributes: requestBody.attributes
      - text: 'Reconfigure journey {journeyId} activation {journeyActivationStepId}: id {id}, type {type}, attributes {attributes}, relationships {relationships}.'
        slots:
          journeyId: path.journeyId
          journeyActivationStepId: path.journeyActivationStepId
          id: requestBody.id
          type: requestBody.type
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/pause'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause a journey and its activation schedules
      effect: write
      questions:
      - Can I temporarily stop a journey and its scheduled activations?
      - What pauses all activation schedules tied to a journey?
      instructions:
      - text: Pause journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Pause journey {journeyId} and its activation schedules.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/resume'].patch
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused journey
      effect: write
      questions:
      - Can I restart a journey I paused earlier?
      - What turns a paused journey's activation schedules back on?
      instructions:
      - text: Resume journey {journeyId}.
        slots:
          journeyId: path.journeyId
      - text: Resume paused journey {journeyId} and its activation schedules.
        slots:
          journeyId: path.journeyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journeys/{journeyId}/journey_stages/{journeyStageId}/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List profiles in a journey stage
      effect: read
      questions:
      - Which customers are sitting in one specific stage of a journey?
      - Can I list profiles for just a single journey stage?
      instructions:
      - text: List the profiles in stage {journeyStageId} of journey {journeyId}.
        slots:
          journeyStageId: path.journeyStageId
          journeyId: path.journeyId
      - text: Show customers currently in journey {journeyId} stage {journeyStageId}.
        slots:
          journeyId: path.journeyId
          journeyStageId: path.journeyStageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journey bundle and its versions
      effect: read
      questions:
      - Which versions of a journey are kept in a journey bundle?
      - Can I see the information for a journey bundle?
      instructions:
      - text: Show journey bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: List the journey versions in bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a journey bundle
      effect: destructive
      questions:
      - Can I delete a whole journey bundle rather than one journey?
      - What removes a journey bundle with all its versions?
      instructions:
      - text: Delete journey bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: Remove the journey bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a journey bundle's metadata
      effect: write
      questions:
      - Can I rename a journey bundle or change its description?
      - Which journey version does a bundle treat as latest, and can I change it?
      instructions:
      - text: Update journey bundle {journeyBundleId} with attributes {attributes}.
        slots:
          journeyBundleId: path.journeyBundleId
          attributes: requestBody.attributes
      - text: Set the name and description of journey bundle {journeyBundleId} to {attributes}.
        slots:
          journeyBundleId: path.journeyBundleId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest journey in a bundle
      effect: read
      questions:
      - Which journey is the newest version in a bundle?
      - Can I fetch only the most recent journey from a journey bundle?
      instructions:
      - text: Get the latest journey in bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: Show the newest journey version of bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics across a journey bundle
      effect: read
      questions:
      - How are all the journey versions in a bundle performing?
      - Can I compare statistics for every journey under one bundle?
      instructions:
      - text: Show the statistics for journey bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: Get the per-journey statistics under bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}/conversion_sankey_charts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get conversion sankey charts for a journey bundle
      effect: read
      questions:
      - Is there conversion flow chart data across all versions in a journey bundle?
      - What conversion sankey charts exist for the journeys in a bundle?
      instructions:
      - text: Get the conversion sankey charts for journey bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: List bundle-wide conversion flow charts for bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}/activation_sankey_charts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get activation sankey charts for a journey bundle
      effect: read
      questions:
      - Where do I see how profiles flowed into activations across every version of a bundled journey?
      - What activation sankey charts exist for the journeys in a bundle?
      instructions:
      - text: Get the activation sankey charts for journey bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: List bundle-wide activation flow charts for bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}/activations'].get
  update:
    x-apievangelist-phrasing:
      intent: List activations of a journey bundle
      effect: read
      questions:
      - Which activations are associated with a journey bundle as a whole?
      - Can I see every activation used across a bundle's journey versions?
      instructions:
      - text: List the activations for journey bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: Show activations tied to bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}/journeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new journey version to a bundle
      effect: write
      questions:
      - Can I start a new version of a journey by copying the latest one in its bundle?
      - What creates the next journey version inside a bundle?
      instructions:
      - text: Create a new journey in bundle {journeyBundleId} copied from the latest version.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: Add a journey version to bundle {journeyBundleId} copied from journey {sourceId}.
        slots:
          journeyBundleId: path.journeyBundleId
          sourceId: requestBody.sourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/journey_bundles/{journeyBundleId}/journeys_appendable'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a journey can be added to a bundle
      effect: read
      questions:
      - Is a journey bundle currently able to take another journey version?
      - Can I validate before appending a new journey to a bundle?
      instructions:
      - text: Check whether a new journey can be appended to bundle {journeyBundleId}.
        slots:
          journeyBundleId: path.journeyBundleId
      - text: Validate that bundle {journeyBundleId} accepts another journey version.
        slots:
          journeyBundleId: path.journeyBundleId
      method: generated
      generated: '2026-10-01'