Adobe Campaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Campaign Standard Profiles API

6 actions 6 updates phrasing extends openapi/adobe-campaign-profiles-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/profile'].get
$.paths['/profileAndServices/profile'].post
$.paths['/profileAndServices/profile/{PKEY}'].get
$.paths['/profileAndServices/profile/{PKEY}'].delete
$.paths['/profileAndServices/profile/{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 Profiles API
  version: 1.0.0
extends: openapi/adobe-campaign-profiles-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/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: List recipient profiles
      effect: read
      questions:
      - How do I list the recipient profiles in Adobe Campaign Standard?
      - Can I sort profiles by email in descending order?
      - What do I do when paginating a profile table with over 100,000 records?
      instructions:
      - text: List recipient profiles.
      - text: Show {count} profiles sorted by {order}.
        slots:
          count: query._lineCount
          order: query._order
      - text: Page through all profiles with forced pagination set to {force}.
        slots:
          force: query._forcePagination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/profile'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a recipient profile
      effect: write
      questions:
      - How do I add a new contact to Adobe Campaign?
      - Is an email address required when creating a profile?
      - Can I set a preferred language and mobile phone on a new profile?
      instructions:
      - text: Create a profile for {email}.
        slots:
          email: requestBody.email
      - text: Add a new contact {first_name} {last_name} with email {email}.
        slots:
          first_name: requestBody.firstName
          last_name: requestBody.lastName
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/profile/{PKEY}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recipient profile
      effect: read
      questions:
      - How do I look up a single recipient profile?
      - Can I retrieve one contact's attributes by PKEY?
      instructions:
      - text: Get profile {profile}.
        slots:
          profile: path.PKEY
      - text: Show the attributes of contact {profile}.
        slots:
          profile: path.PKEY
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/profile/{PKEY}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a recipient profile
      effect: destructive
      questions:
      - How do I permanently remove a contact from Campaign?
      - Can I delete a single recipient profile by its PKEY?
      instructions:
      - text: Delete profile {profile}.
        slots:
          profile: path.PKEY
      - text: Remove contact {profile} from the database.
        slots:
          profile: path.PKEY
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profileAndServices/profile/{PKEY}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a recipient profile
      effect: write
      questions:
      - How do I change an existing contact's email or phone number?
      - Can I block an existing profile from receiving email only?
      - Is it possible to partially update a profile without resending every field?
      instructions:
      - text: Change the email of profile {profile} to {email}.
        slots:
          profile: path.PKEY
          email: requestBody.email
      - text: Set email denylisting on profile {profile} to {blocked}.
        slots:
          profile: path.PKEY
          blocked: requestBody.blackListEmail
      - text: Update the mobile phone of existing contact {profile} to {mobile}.
        slots:
          profile: path.PKEY
          mobile: requestBody.mobilePhone
      method: generated
      generated: '2026-09-26'