Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Trigger campaigns using Execution API

7 actions 7 updates phrasing extends openapi/adobe-suite-execution-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/im/executions/unitary'].post
$.paths['/im/executions/audience'].post
$.paths['/im/executions/audience/{executionId}'].get
$.paths['/im/executions/schedules/{scheduleId}'].get
$.paths['/im/executions/schedules/{scheduleId}'].delete
$.paths['/im/executions/highthroughput'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Trigger campaigns using Execution API
  version: 1.0.0
extends: openapi/adobe-suite-execution-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: 6
- target: $.paths['/im/executions/unitary'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an API-triggered message to specific recipients
      effect: write
      questions:
      - How do I trigger an API campaign message to a handful of named recipients in Journey Optimizer?
      - Does a unitary message execution need a unique request ID?
      instructions:
      - text: Trigger campaign {campaignId} for recipients {recipients} with request ID {requestId}.
        slots:
          campaignId: requestBody.campaignId
          recipients: requestBody.recipients
          requestId: requestBody.requestId
      - text: Send a one-off unitary message from campaign {campaignId} to {recipients} (request {requestId}).
        slots:
          campaignId: requestBody.campaignId
          recipients: requestBody.recipients
          requestId: requestBody.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/im/executions/audience'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger or schedule a message to an audience
      effect: write
      questions:
      - How do I send a campaign message to a whole Experience Platform audience?
      - Can I schedule an audience-based campaign to run at a later time?
      - Can I pass context data to fill in variables in the message content?
      instructions:
      - text: Send campaign {campaignId} to audience {audience}.
        slots:
          campaignId: requestBody.campaignId
          audience: requestBody.audience
      - text: Schedule campaign {campaignId} for audience {audience} at {schedule}.
        slots:
          campaignId: requestBody.campaignId
          audience: requestBody.audience
          schedule: requestBody.schedule
      - text: Trigger audience campaign {campaignId} with context {context}.
        slots:
          campaignId: requestBody.campaignId
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/im/executions/audience/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an audience message execution by execution ID
      effect: read
      questions:
      - How do I check whether my audience campaign send finished, using its execution ID?
      - What status does an audience-based message execution report?
      instructions:
      - text: Get the status of audience execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Check how audience send {executionId} is progressing.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/im/executions/schedules/{scheduleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an audience message execution by schedule ID
      effect: read
      questions:
      - How do I see the status of a scheduled audience campaign using its schedule ID?
      - Has my scheduled campaign run yet?
      instructions:
      - text: Get the execution status for schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      - text: Check whether scheduled campaign run {scheduleId} has executed.
        slots:
          scheduleId: path.scheduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/im/executions/schedules/{scheduleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled campaign execution
      effect: destructive
      questions:
      - How do I cancel a scheduled campaign send before it goes out?
      - Can I delete a scheduled execution after it has already triggered?
      instructions:
      - text: Delete scheduled execution {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      - text: Cancel the campaign send scheduled under {scheduleId} before it fires.
        slots:
          scheduleId: path.scheduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/im/executions/highthroughput'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a high-throughput API-triggered message
      effect: write
      questions:
      - Is there a high-throughput option for triggering unitary campaign messages at volume?
      - How do I fire a high-throughput campaign message to specific recipients?
      instructions:
      - text: Trigger high-throughput campaign {campaignId} for {recipients} with request ID {requestId}.
        slots:
          campaignId: requestBody.campaignId
          recipients: requestBody.recipients
          requestId: requestBody.requestId
      - text: Use the high-throughput endpoint to send campaign {campaignId} to {recipients} (request {requestId}).
        slots:
          campaignId: requestBody.campaignId
          recipients: requestBody.recipients
          requestId: requestBody.requestId
      method: generated
      generated: '2026-09-26'