Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Journey Optimizer Campaigns API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/campaign/campaigns'].get
$.paths['/campaign/campaigns'].post
$.paths['/campaign/campaigns/{campaignId}'].get
$.paths['/campaign/campaigns/{campaignId}'].delete

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 Adobe Experience Cloud Adobe Journey Optimizer Campaigns API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-campaigns-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: 4
- target: $.paths['/campaign/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List marketing campaigns
      effect: read
      questions:
      - Which marketing campaigns are set up in Journey Optimizer?
      - Can I see each campaign's channel, status and schedule in one list?
      instructions:
      - text: List campaigns in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {limit} campaigns from sandbox {sandbox}.
        slots:
          limit: query.limit
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a marketing campaign
      effect: write
      questions:
      - How do I launch a new email or push campaign to an audience?
      - Can I attach an audience and schedule when creating a campaign?
      instructions:
      - text: Create a {channel} campaign named {name} in sandbox {sandbox}.
        slots:
          channel: requestBody.channel
          name: requestBody.name
          sandbox: header.x-sandbox-name
      - text: Create campaign {name} on {channel} targeting audience {audienceId}.
        slots:
          name: requestBody.name
          channel: requestBody.channel
          audienceId: requestBody.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/campaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a marketing campaign
      effect: read
      questions:
      - What is the full setup of one specific campaign?
      - Where can I look up a single Journey Optimizer campaign by ID?
      instructions:
      - text: Show campaign {campaignId} in sandbox {sandbox}.
        slots:
          campaignId: path.campaignId
          sandbox: header.x-sandbox-name
      - text: Get the definition of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/campaigns/{campaignId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a campaign
      effect: destructive
      questions:
      - Can I delete a campaign that is still running?
      - Which campaign statuses allow deletion?
      instructions:
      - text: Delete campaign {campaignId} from sandbox {sandbox}.
        slots:
          campaignId: path.campaignId
          sandbox: header.x-sandbox-name
      - text: Remove draft campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'