Adobe Experience Cloud · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Experience Cloud Offers API
11 actions
11 updates
phrasing
extends
openapi/adobe-experience-cloud-offers-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/offer/offers'].get
$.paths['/offer/offers'].post
$.paths['/offer/offers/{offerId}'].get
$.paths['/offer/offers/{offerId}'].put
$.paths['/offer/offers/{offerId}'].delete
$.paths['/target/offers'].get
$.paths['/target/offers'].post
$.paths['/target/offers/{offerId}'].get
$.paths['/target/offers/{offerId}'].put
$.paths['/target/offers/{offerId}'].delete
OpenAPI Overlay
# 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 Offers API
version: 1.0.0
extends: openapi/adobe-experience-cloud-offers-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: 10
- target: $.paths['/offer/offers'].get
update:
x-apievangelist-phrasing:
intent: List decisioning offers in the offer library
effect: read
questions:
- Which personalized and fallback offers are in our Journey Optimizer offer library?
- Can I limit how many decisioning offers come back per sandbox?
instructions:
- text: List offer library offers in sandbox {sandbox}.
slots:
sandbox: header.x-sandbox-name
- text: Show {limit} decisioning offers from the offer library.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/offer/offers'].post
update:
x-apievangelist-phrasing:
intent: Create a personalized decisioning offer
effect: write
questions:
- Can I create a personalized offer with eligibility rules for offer decisioning?
- Is it possible to give a decisioning offer a start and end date?
instructions:
- text: Create personalized offer {name} in the offer library for sandbox {sandbox}.
slots:
name: requestBody.name
sandbox: header.x-sandbox-name
- text: Create decisioning offer {name} with eligibility rule {eligibilityRule} and priority {priority}.
slots:
name: requestBody.name
eligibilityRule: requestBody.eligibilityRule
priority: requestBody.priority
method: generated
generated: '2026-10-01'
- target: $.paths['/offer/offers/{offerId}'].get
update:
x-apievangelist-phrasing:
intent: Get a decisioning offer
effect: read
questions:
- What eligibility rules and constraints apply to one offer in the offer library?
- Where can I see the representations of a decisioning offer?
instructions:
- text: Show offer library offer {offerId} in sandbox {sandbox}.
slots:
offerId: path.offerId
sandbox: header.x-sandbox-name
- text: Get the eligibility rules of decisioning offer {offerId}.
slots:
offerId: path.offerId
method: generated
generated: '2026-10-01'
- target: $.paths['/offer/offers/{offerId}'].put
update:
x-apievangelist-phrasing:
intent: Update a decisioning offer
effect: write
questions:
- Can I change the priority of an offer in the offer library?
- Is it possible to extend the end date of a personalized decisioning offer?
instructions:
- text: Set priority {priority} on decisioning offer {offerId}, keeping name {name}.
slots:
priority: requestBody.priority
offerId: path.offerId
name: requestBody.name
- text: Change the end date of offer library offer {offerId} to {endDate}.
slots:
offerId: path.offerId
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/offer/offers/{offerId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a decisioning offer
effect: destructive
questions:
- Why can't I delete an offer that an active decision uses?
- Can I remove a personalized offer from the offer library?
instructions:
- text: Delete offer library offer {offerId} in sandbox {sandbox}.
slots:
offerId: path.offerId
sandbox: header.x-sandbox-name
- text: Remove decisioning offer {offerId}.
slots:
offerId: path.offerId
method: generated
generated: '2026-10-01'
- target: $.paths['/target/offers'].get
update:
x-apievangelist-phrasing:
intent: List Target content offers
effect: read
questions:
- Which HTML, JSON and redirect offers are configured in Adobe Target?
- Can I page through Target content offers with an offset?
instructions:
- text: List my Target content offers.
- text: Show {limit} Target offers starting at offset {offset}.
slots:
limit: query.limit
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/target/offers'].post
update:
x-apievangelist-phrasing:
intent: Create a Target content offer
effect: write
questions:
- Can I create an HTML or redirect offer in Target through the API?
- What type of content can a new Target offer hold?
instructions:
- text: Create a {type} Target offer named {name} with content {content}.
slots:
type: requestBody.type
name: requestBody.name
content: requestBody.content
- text: Add a Target redirect offer {name} pointing to {content}.
slots:
name: requestBody.name
content: requestBody.content
method: generated
generated: '2026-10-01'
- target: $.paths['/target/offers/{offerId}'].get
update:
x-apievangelist-phrasing:
intent: Get a Target content offer
effect: read
questions:
- Where can I see the content payload of one Target offer?
- What metadata does a single Target offer carry?
instructions:
- text: Show Target offer {offerId}.
slots:
offerId: path.offerId
- text: Get the content of Target offer {offerId}.
slots:
offerId: path.offerId
method: generated
generated: '2026-10-01'
- target: $.paths['/target/offers/{offerId}'].put
update:
x-apievangelist-phrasing:
intent: Update a Target content offer
effect: write
questions:
- Can I swap the HTML of an existing Target offer?
- Is renaming a Target content offer supported?
instructions:
- text: Replace the content of Target offer {offerId} with {content}, keeping name {name} and type {type}.
slots:
offerId: path.offerId
content: requestBody.content
name: requestBody.name
type: requestBody.type
- text: Rename Target offer {offerId} to {name}.
slots:
offerId: path.offerId
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/target/offers/{offerId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Target content offer
effect: destructive
questions:
- Can I delete a Target offer that an active activity uses?
- Is removing a Target content offer permanent?
instructions:
- text: Delete Target offer {offerId}.
slots:
offerId: path.offerId
- text: Permanently remove Target content offer {offerId}.
slots:
offerId: path.offerId
method: generated
generated: '2026-10-01'