Adobe Experience Cloud · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/adobe-experience-cloud-messages-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['/messaging/messages'].get
$.paths['/messaging/messages'].post
$.paths['/messaging/messages/{messageId}'].get
$.paths['/messaging/messages/{messageId}'].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 Messages API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-messages-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['/messaging/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel messages
      effect: read
      questions:
      - Which email, push, SMS and in-app messages are configured?
      - Can I limit how many message configurations are returned?
      instructions:
      - text: List messages in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {limit} message configurations.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messaging/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a channel message
      effect: write
      questions:
      - How do I set up a new push or SMS message configuration?
      - Can I include content when creating a channel message?
      instructions:
      - text: Create a {channel} message named {name}.
        slots:
          channel: requestBody.channel
          name: requestBody.name
      - text: Create message {name} for {channel} with content {content} in sandbox {sandbox}.
        slots:
          name: requestBody.name
          channel: requestBody.channel
          content: requestBody.content
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messaging/messages/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel message
      effect: read
      questions:
      - What content and delivery settings does a specific message have?
      - Where can I look up one message configuration by ID?
      instructions:
      - text: Show message {messageId}.
        slots:
          messageId: path.messageId
      - text: Get the content of message {messageId} in sandbox {sandbox}.
        slots:
          messageId: path.messageId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messaging/messages/{messageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a channel message
      effect: destructive
      questions:
      - Can I delete a message that an active journey still uses?
      - What blocks a message configuration from being removed?
      instructions:
      - text: Delete message {messageId}.
        slots:
          messageId: path.messageId
      - text: Remove message configuration {messageId} from sandbox {sandbox}.
        slots:
          messageId: path.messageId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'