API Evangelist conversational phrasing for cdp-api Activations 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 Activations API
  version: 1.0.0
extends: openapi/treasure-data-activations-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: 17
- target: $.paths['/audiences/{audienceId}/folders/{folderId}/syndications'].get
  update:
    x-apievangelist-phrasing:
      intent: List activations under a segment folder
      effect: read
      questions:
      - Can I see every activation inside a segment folder, including its subfolders?
      - Which activations in a folder use a given connection type or schedule status?
      instructions:
      - text: List all activations recursively under folder {folderId} in parent segment {audienceId}.
        slots:
          folderId: path.folderId
          audienceId: path.audienceId
      - text: Show activations under folder {folderId} of parent segment {audienceId} whose name includes {name_include}.
        slots:
          folderId: path.folderId
          audienceId: path.audienceId
          name_include: query.name_include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/segments/{segmentId}/syndications'].get
  update:
    x-apievangelist-phrasing:
      intent: List activations of a segment (audience API)
      effect: read
      questions:
      - What activations are attached to this segment in my parent segment?
      - Where do I find the activations that push one segment out to destinations?
      instructions:
      - text: List the activations for segment {segmentId} in parent segment {audienceId}.
        slots:
          segmentId: path.segmentId
          audienceId: path.audienceId
      - text: Show which activations send segment {segmentId} (parent segment {audienceId}) to destinations.
        slots:
          segmentId: path.segmentId
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/segments/{segmentId}/syndications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an activation for a segment
      effect: write
      questions:
      - How do I set up an activation that sends a segment to a destination connection in Treasure Data?
      - Can an activation run on a cron schedule with email notifications?
      instructions:
      - text: Create an activation named {name} for segment {segmentId} in parent segment {audienceId}.
        slots:
          name: requestBody.name
          segmentId: path.segmentId
          audienceId: path.audienceId
      - text: Create activation {name} on segment {segmentId} of parent segment {audienceId} using connection {connectionId}.
        slots:
          name: requestBody.name
          segmentId: path.segmentId
          audienceId: path.audienceId
          connectionId: requestBody.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activation of a segment by ID
      effect: read
      questions:
      - How can I look up the settings of a single activation on a parent-segment segment?
      - What schedule and connection does a specific activation use?
      instructions:
      - text: Show activation {syndicationId} of segment {segmentId} in parent segment {audienceId}.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
      - text: Get the schedule and connection of activation {syndicationId} on segment {segmentId}, parent segment {audienceId}.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an activation's settings
      effect: write
      questions:
      - Can I change the schedule or columns of an existing activation?
      - How do I rename an activation that's already sending a segment out?
      instructions:
      - text: Rename activation {syndicationId} on segment {segmentId} in parent segment {audienceId} to {name}.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
          name: requestBody.name
      - text: Change the cron of activation {syndicationId} (segment {segmentId}, parent segment {audienceId}, name {name}) to {cron}.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
          name: requestBody.name
          cron: requestBody.cron
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activation from a segment
      effect: destructive
      questions:
      - How do I remove an activation from a segment under a parent segment?
      - Can I stop a segment being sent to a destination by deleting its activation?
      instructions:
      - text: Delete activation {syndicationId} from segment {segmentId} in parent segment {audienceId}.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
      - text: Remove activation {syndicationId} so segment {segmentId} in parent segment {audienceId} stops being sent.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an activation now (legacy Audience Studio)
      effect: write
      questions:
      - How do I trigger an activation to run immediately in legacy Audience Studio?
      - Can I manually kick off an activation instead of waiting for its schedule?
      instructions:
      - text: Run activation {syndicationId} of segment {segmentId} in parent segment {audienceId} now.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
      - text: Trigger legacy activation {syndicationId} for segment {segmentId} in parent segment {audienceId} outside its schedule.
        slots:
          syndicationId: path.syndicationId
          segmentId: path.segmentId
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/syndications'].get
  update:
    x-apievangelist-phrasing:
      intent: List all activations in a parent segment
      effect: read
      questions:
      - What activations exist across a whole parent segment and what are their statuses?
      - Can I get the activation list for a parent segment without the detail fields?
      instructions:
      - text: List every activation in parent segment {audienceId} with their schedules.
        slots:
          audienceId: path.audienceId
      - text: List activations in parent segment {audienceId} with without_detail set to {without_detail}.
        slots:
          audienceId: path.audienceId
          without_detail: query.without_detail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/segments/{segmentId}/syndications'].get
  update:
    x-apievangelist-phrasing:
      intent: List a segment's activations (entities API)
      effect: read
      questions:
      - Is there a JSON:API endpoint that lists a segment's activations by segment ID alone?
      - Which activations belong to a segment in the entities API?
      instructions:
      - text: List activations for segment {segmentId} using the entities API.
        slots:
          segmentId: path.segmentId
      - text: Show the JSON:API activation records for segment {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/segments/{segmentId}/syndications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an activation via the entities API
      effect: write
      questions:
      - Can I create an activation with only a segment ID, using the JSON:API entities endpoint?
      - What does a JSON:API activation create payload need for type and attributes?
      instructions:
      - text: Create an entities-API activation on segment {segmentId} with attributes {attributes}.
        slots:
          segmentId: path.segmentId
          attributes: requestBody.attributes
      - text: Add a JSON:API activation of type {type} to segment {segmentId}.
        slots:
          type: requestBody.type
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/segments/{segmentId}/syndications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one activation via the entities API
      effect: read
      questions:
      - How do I fetch a single activation from the entities API by its ID?
      - Can I read an activation's attributes in JSON:API format?
      instructions:
      - text: Get entities-API activation {id} on segment {segmentId}.
        slots:
          id: path.id
          segmentId: path.segmentId
      - text: Read the JSON:API attributes of activation {id} for segment {segmentId}.
        slots:
          id: path.id
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/segments/{segmentId}/syndications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activation via the entities API
      effect: destructive
      questions:
      - Can I delete an activation through the JSON:API entities endpoint?
      - How is an activation removed when I only know the segment ID and activation ID?
      instructions:
      - text: Delete entities-API activation {id} from segment {segmentId}.
        slots:
          id: path.id
          segmentId: path.segmentId
      - text: Remove JSON:API activation {id} belonging to segment {segmentId}.
        slots:
          id: path.id
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/segments/{segmentId}/syndications/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an activation via the entities API
      effect: write
      questions:
      - How do I partially update an activation's attributes with a JSON:API PATCH?
      - Can I change a single attribute of an activation in the entities API?
      instructions:
      - text: Patch entities-API activation {id} on segment {segmentId} with attributes {attributes}.
        slots:
          id: path.id
          segmentId: path.segmentId
          attributes: requestBody.attributes
      - text: Partially update JSON:API activation {id} of segment {segmentId}.
        slots:
          id: path.id
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/segments/{segmentId}/syndications/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an activation via the entities API
      effect: write
      questions:
      - Can I trigger an activation run through the entities API by segment and activation ID?
      - What starts an entities-API activation immediately?
      instructions:
      - text: Run entities-API activation {id} on segment {segmentId}.
        slots:
          id: path.id
          segmentId: path.segmentId
      - text: Trigger activation {id} of segment {segmentId} via the entities endpoint now.
        slots:
          id: path.id
          segmentId: path.segmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/syndications'].get
  update:
    x-apievangelist-phrasing:
      intent: List activation summaries by parent segment
      effect: read
      questions:
      - Can I get a summary list of activations for a parent segment from the entities API?
      - Which activations hang off one parent segment, in summary form?
      instructions:
      - text: List activation summaries for parent segment {parentSegmentId} via the entities API.
        slots:
          parentSegmentId: path.parentSegmentId
      - text: Show entities-API activations under parent segment {parentSegmentId}.
        slots:
          parentSegmentId: path.parentSegmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/user_defined_workflow_projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow projects for custom activations
      effect: read
      questions:
      - Which workflow projects can I pick for a custom workflow activation?
      - Can I filter workflow project names by a pattern?
      instructions:
      - text: List workflow project names for parent segment {parentSegmentId}.
        slots:
          parentSegmentId: path.parentSegmentId
      - text: Find workflow projects matching {namePattern} for parent segment {parentSegmentId}, after {lastId}.
        slots:
          namePattern: query.namePattern
          parentSegmentId: path.parentSegmentId
          lastId: query.lastId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/user_defined_workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows in a project for custom activations
      effect: read
      questions:
      - Which workflows inside a project can a custom activation call?
      - What workflow names exist in a given workflow project for my parent segment?
      instructions:
      - text: Show the individual workflows defined inside project {workflowProjectName} for parent segment {parentSegmentId}.
        slots:
          workflowProjectName: query.workflowProjectName
          parentSegmentId: path.parentSegmentId
      - text: Show workflows of project {workflowProjectName} usable by parent segment {parentSegmentId}.
        slots:
          workflowProjectName: query.workflowProjectName
          parentSegmentId: path.parentSegmentId
      method: generated
      generated: '2026-10-01'