Generated by API Evangelist
Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for AJO Customer Loyalty Challenge State Challenge Controller…
version: 1.0.0
extends: openapi/adobe-suite-challenge-controller-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: 3
- target: $.paths['/loyalty/challenges/{profileId}/withdraw'].post
update:
x-apievangelist-phrasing:
intent: Withdraw a profile from loyalty challenges
effect: destructive
questions:
- How do I pull a loyalty member out of several challenges at once?
- Can I withdraw a profile from only specific challenges by ID?
instructions:
- text: Withdraw profile {profileId} from challenges {idList}.
slots:
profileId: path.profileId
idList: requestBody.idList
- text: Remove member {profileId} from the listed loyalty challenges {idList}.
slots:
profileId: path.profileId
idList: requestBody.idList
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/challenges/state'].post
update:
x-apievangelist-phrasing:
intent: Get a profile's active challenge state
effect: read
questions:
- Which loyalty challenges is a member currently active in, and how far along are they?
- Can I check a profile's challenge progress in test mode?
instructions:
- text: Get the active challenge state for profile {pid}.
slots:
pid: query.pid
- text: Show challenge progress for profile {pid} in test mode {test}.
slots:
pid: query.pid
test: query.test
method: generated
generated: '2026-09-26'
- target: $.paths['/loyalty/challenges/signup'].post
update:
x-apievangelist-phrasing:
intent: Sign a profile up for loyalty challenges
effect: write
questions:
- How do I enroll a loyalty member in multiple challenges in one call?
- Can a profile be signed up for a list of challenges at once?
instructions:
- text: Sign profile {profileId} up for challenges {idList}.
slots:
profileId: requestBody.profileId
idList: requestBody.idList
- text: 'Enroll member {profileId} in these loyalty challenges: {idList}.'
slots:
profileId: requestBody.profileId
idList: requestBody.idList
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.