Adobe Campaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Campaign Standard Transactional Messages API

3 actions 3 updates phrasing extends openapi/adobe-campaign-transactional-messages-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe Campaign's API. It is a proposal applied on top of the contract, not a document Adobe Campaign publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/{transactionalAPI}/{eventID}'].get

$.paths['/{transactionalAPI}/{eventID}'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Campaign Standard Transactional Messages API
  version: 1.0.0
extends: openapi/adobe-campaign-transactional-messages-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: 2
- target: $.paths['/{transactionalAPI}/{eventID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a transactional event's status
      effect: read
      questions:
      - How do I check whether a transactional message I triggered was delivered?
      - What does it mean if a transactional event status is routingFailed or tooOld?
      - Can I see if an event is still pending or already processed?
      instructions:
      - text: Check the status of event {event_id} on transactional API {api}.
        slots:
          event_id: path.eventID
          api: path.transactionalAPI
      - text: Tell me whether event {event_id} from {api} was processed or failed.
        slots:
          event_id: path.eventID
          api: path.transactionalAPI
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{transactionalAPI}/{eventID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a transactional message
      effect: write
      questions:
      - How do I send an order confirmation email with Adobe Campaign Standard?
      - Can I schedule a transactional message for later or give it an expiration time?
      - Which fields personalize the message template when triggering an event?
      instructions:
      - text: Trigger event {event_id} on {api} to email {email} with context {ctx}.
        slots:
          event_id: path.eventID
          api: path.transactionalAPI
          email: requestBody.email
          ctx: requestBody.ctx
      - text: Send the {api} event {event_id} by SMS to {mobile}.
        slots:
          api: path.transactionalAPI
          event_id: path.eventID
          mobile: requestBody.mobilePhone
      - text: Schedule event {event_id} on {api} for {when}.
        slots:
          event_id: path.eventID
          api: path.transactionalAPI
          when: requestBody.scheduled
      method: generated
      generated: '2026-09-26'