Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Campaign Transactional…

3 actions 3 updates phrasing extends openapi/adobe-experience-cloud-transactional-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 3

$.info
$.paths['/campaign/mcAdobe/{transactionalMessageId}'].post
$.paths['/campaign/mcAdobe/{transactionalMessageId}/{eventId}'].get

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 Campaign Transactional…
  version: 1.0.0
extends: openapi/adobe-experience-cloud-transactional-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: 2
- target: $.paths['/campaign/mcAdobe/{transactionalMessageId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional message
      effect: write
      questions:
      - How do I send an order confirmation email triggered by an event?
      - What context data can I pass into a transactional message?
      instructions:
      - text: Send transactional message {transactionalMessageId} to {email} with context {ctx}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          email: requestBody.email
          ctx: requestBody.ctx
      - text: Trigger a password reset message {transactionalMessageId} for {email} using data {ctx}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          email: requestBody.email
          ctx: requestBody.ctx
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/mcAdobe/{transactionalMessageId}/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a transactional message's delivery
      effect: read
      questions:
      - Was a transactional message I already sent delivered?
      - Where can I track delivery of an event-triggered email?
      instructions:
      - text: Check delivery status of event {eventId} for message {transactionalMessageId}.
        slots:
          eventId: path.eventId
          transactionalMessageId: path.transactionalMessageId
      - text: Get the status of transactional event {eventId} on message {transactionalMessageId}.
        slots:
          eventId: path.eventId
          transactionalMessageId: path.transactionalMessageId
      method: generated
      generated: '2026-10-01'