Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Campaign API

5 actions 5 updates phrasing extends openapi/adobe-experience-cloud-campaign-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/profileAndServices/service'].get
$.paths['/campaign/profileAndServices/service'].post
$.paths['/campaign/profileAndServices/service/{servicePKey}'].get
$.paths['/campaign/profileAndServices/service/{servicePKey}/subscriptions'].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 Adobe Experience Cloud Adobe Campaign API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-campaign-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/profileAndServices/service'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription services
      effect: read
      questions:
      - Which mailing lists or subscription topics exist in Adobe Campaign?
      - Can I limit how many subscription services come back per page?
      instructions:
      - text: List all subscription services.
      - text: Show the first {lineCount} subscription services.
        slots:
          lineCount: query._lineCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/profileAndServices/service'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription service
      effect: write
      questions:
      - How do I set up a new newsletter or mailing list in Campaign?
      - Can I pick a message type when creating a subscription service?
      instructions:
      - text: Create a subscription service labeled {label}.
        slots:
          label: requestBody.label
      - text: Create subscription service {label} with internal name {name} for {messageType} messages.
        slots:
          label: requestBody.label
          name: requestBody.name
          messageType: requestBody.messageType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/profileAndServices/service/{servicePKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription service
      effect: read
      questions:
      - What are the settings of one specific subscription service?
      - Where can I look up a mailing list by its primary key?
      instructions:
      - text: Show subscription service {servicePKey}.
        slots:
          servicePKey: path.servicePKey
      - text: Get the details of service {servicePKey}.
        slots:
          servicePKey: path.servicePKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/profileAndServices/service/{servicePKey}/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a profile to a service
      effect: write
      questions:
      - Can I add an existing subscriber to a newsletter through the API?
      - What do I need to subscribe a profile to a mailing list?
      instructions:
      - text: Subscribe profile {subscriber} to service {servicePKey}.
        slots:
          subscriber: requestBody.subscriber
          servicePKey: path.servicePKey
      - text: Add subscriber {subscriber} to the mailing list {servicePKey}.
        slots:
          subscriber: requestBody.subscriber
          servicePKey: path.servicePKey
      method: generated
      generated: '2026-10-01'