Adobe Campaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Campaign Standard Profile And Services API

6 actions 6 updates phrasing extends openapi/adobe-campaign-profileandservices-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 6

$.info
$.paths['/profileAndServices/service'].get
$.paths['/profileAndServices/service'].post
$.paths['/profileAndServices/service/{PKEY}'].get
$.paths['/profileAndServices/service/{PKEY}'].delete
$.paths['/profileAndServices/service/{PKEY}'].patch

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 Profile And Services API
  version: 1.0.0
extends: openapi/adobe-campaign-profileandservices-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: 5
- target: $.paths['/profileAndServices/service'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription services
      effect: read
      questions:
      - How do I see all the subscription services set up in Adobe Campaign?
      - Can I sort my newsletter services by a field?
      - What subscription services exist that people can sign up for?
      instructions:
      - text: List all subscription services.
      - text: Show subscription services sorted by {order}.
        slots:
          order: query._order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/service'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription service
      effect: write
      questions:
      - How do I set up a new newsletter or subscription service?
      - Can I choose the message type when creating a service?
      - What is the minimum needed to create a service besides a label?
      instructions:
      - text: Create a subscription service labeled {label}.
        slots:
          label: requestBody.label
      - text: Set up a new {message_type} service called {label} with internal name {name}.
        slots:
          message_type: requestBody.messageType
          label: requestBody.label
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/service/{PKEY}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription service
      effect: read
      questions:
      - How do I look up the details of one subscription service?
      - Can I fetch a single service by its PKEY?
      instructions:
      - text: Get the details of service {service}.
        slots:
          service: path.PKEY
      - text: Show me subscription service {service}.
        slots:
          service: path.PKEY
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/service/{PKEY}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription service
      effect: destructive
      questions:
      - How do I permanently remove a subscription service I no longer use?
      - Can I delete a newsletter service by its PKEY?
      instructions:
      - text: Delete subscription service {service}.
        slots:
          service: path.PKEY
      - text: Remove the retired service {service} from Campaign.
        slots:
          service: path.PKEY
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/service/{PKEY}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription service
      effect: write
      questions:
      - How do I rename an existing subscription service?
      - Can I change the start and end dates of a service after creating it?
      - Is it possible to switch an existing service's message type?
      instructions:
      - text: Rename existing service {service} to {label}.
        slots:
          service: path.PKEY
          label: requestBody.label
      - text: Set service {service} to run from {start} until {end}.
        slots:
          service: path.PKEY
          start: requestBody.start
          end: requestBody.end
      method: generated
      generated: '2026-09-26'