Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Profiles API

7 actions 7 updates phrasing extends openapi/adobe-experience-cloud-profiles-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 7

$.info
$.paths['/campaign/profileAndServices/profile'].get
$.paths['/campaign/profileAndServices/profile'].post
$.paths['/campaign/profileAndServices/profile/{profilePKey}'].get
$.paths['/campaign/profileAndServices/profile/{profilePKey}'].delete
$.paths['/campaign/profileAndServices/profile/{profilePKey}'].patch
$.paths['/data/core/ups/access/entities'].get

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 Profiles API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-profiles-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: 6
- target: $.paths['/campaign/profileAndServices/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: List Campaign subscriber profiles
      effect: read
      questions:
      - Can I find Campaign subscribers by email address?
      - How do I page through the subscriber profiles in our Campaign database?
      instructions:
      - text: List Campaign profiles with email {email}.
        slots:
          email: query.email
      - text: Show {lineCount} subscriber profiles starting at line {lineStart}.
        slots:
          lineCount: query._lineCount
          lineStart: query._lineStart
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/profileAndServices/profile'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Campaign subscriber profile
      effect: write
      questions:
      - How do I add a new subscriber to Adobe Campaign?
      - Which attributes can I set when creating a subscriber profile?
      instructions:
      - text: Create a Campaign profile for {email}.
        slots:
          email: requestBody.email
      - text: Add subscriber {firstName} {lastName} with email {email} and phone {phone}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/profileAndServices/profile/{profilePKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Campaign subscriber profile
      effect: read
      questions:
      - Where can I see all attributes of one subscriber by primary key?
      - What custom fields are stored on a specific Campaign profile?
      instructions:
      - text: Show Campaign profile {profilePKey}.
        slots:
          profilePKey: path.profilePKey
      - text: Get all attributes of subscriber {profilePKey}.
        slots:
          profilePKey: path.profilePKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/profileAndServices/profile/{profilePKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Campaign subscriber profile
      effect: destructive
      questions:
      - Can a deleted Campaign subscriber be restored?
      - What happens when I remove a subscriber profile from Campaign?
      instructions:
      - text: Delete Campaign profile {profilePKey}.
        slots:
          profilePKey: path.profilePKey
      - text: Permanently remove subscriber {profilePKey} from the Campaign database.
        slots:
          profilePKey: path.profilePKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/profileAndServices/profile/{profilePKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on a Campaign profile
      effect: write
      questions:
      - Can I change just a subscriber's email without resending every field?
      - Which subscriber attributes can be patched on an existing profile?
      instructions:
      - text: Change the email of Campaign profile {profilePKey} to {email}.
        slots:
          profilePKey: path.profilePKey
          email: requestBody.email
      - text: Update the phone number of subscriber {profilePKey} to {phone}.
        slots:
          profilePKey: path.profilePKey
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/core/ups/access/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a unified profile by identity
      effect: read
      questions:
      - How do I look up a person's unified Experience Platform profile from an email or ECID?
      - Can I fetch experience events tied to one individual's identity?
      instructions:
      - text: Get the {schemaName} entity for identity {entityId} in namespace {entityIdNS}.
        slots:
          schemaName: query.schema.name
          entityId: query.entityId
          entityIdNS: query.entityIdNS
      - text: Look up unified profile {entityId} ({entityIdNS}) using schema {schemaName} in sandbox {sandbox}.
        slots:
          entityId: query.entityId
          entityIdNS: query.entityIdNS
          schemaName: query.schema.name
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'