Adobe Campaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Campaign Standard Subscriptions API

3 actions 3 updates phrasing extends openapi/adobe-campaign-subscriptions-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['/profileAndServices/profile/{PKEY}/subscriptions'].post
$.paths['/profileAndServices/service/{servicePKEY}/subscriptions/{profilePKEY}'].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 Campaign Standard Subscriptions API
  version: 1.0.0
extends: openapi/adobe-campaign-subscriptions-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['/profileAndServices/profile/{PKEY}/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a profile to a service
      effect: write
      questions:
      - How do I sign a profile up for a subscription service using the REST API?
      - Can I subscribe a contact by passing the service PKEY?
      instructions:
      - text: Subscribe profile {profile} to service {service}.
        slots:
          profile: path.PKEY
          service: requestBody.service
      - text: Add contact {profile} as a subscriber of {service}.
        slots:
          profile: path.PKEY
          service: requestBody.service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/service/{servicePKEY}/subscriptions/{profilePKEY}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a profile's subscription from a service
      effect: destructive
      questions:
      - How do I remove a profile's subscription to a service by PKEY?
      - Can I unsubscribe one contact from a service without deleting the profile?
      instructions:
      - text: Unsubscribe profile {profile} from service {service}.
        slots:
          profile: path.profilePKEY
          service: path.servicePKEY
      - text: Remove the subscription of contact {profile} to {service}.
        slots:
          profile: path.profilePKEY
          service: path.servicePKEY
      method: generated
      generated: '2026-09-26'