Adobe Suite Challenges API

Manage the creation, updating, deleting, and retrieval of Challenges

Documentation GitHub OpenAPI

Business capability

Loyalty & Retention Management BC-420.40

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /loyalty/metadata/challenges/{challengeId} Get a loyalty challenge · Retrieve a Challenge by its challengeId #

Ask an LLM

“What tasks and rewards are set up on one particular loyalty challenge?”

“Can I look up a loyalty challenge by its ID to check its state?”

Tell an agent

Show loyalty challenge {challengeId}.

Get the configuration of challenge {challengeId}.

PUT /loyalty/metadata/challenges/{challengeId} Replace a loyalty challenge entirely · Replace an existing challenge by overwriting #

Ask an LLM

“How do I overwrite a whole loyalty challenge definition with a new one?”

“Can I change a challenge's start and end dates by replacing it?”

Tell an agent

Replace challenge {challengeId} with name {name}, running {startDate} to {endDate}.

Overwrite challenge {challengeId} with tasks {tasks} and reward {reward}.

DELETE /loyalty/metadata/challenges/{challengeId} Delete a loyalty challenge and its journey · Delete a challenge and its associated journey #

Ask an LLM

“What happens to the linked journey when I delete a loyalty challenge?”

“How do I permanently remove a loyalty challenge?”

Tell an agent destructive · confirm first

Delete loyalty challenge {challengeId} along with its journey.

Remove challenge {challengeId} for good.

PATCH /loyalty/metadata/challenges/{challengeId} Partially update a loyalty challenge · Patch an existing challenge by root keys if present #

Ask an LLM

“Can I change only a few top-level fields of a challenge without resending the whole thing?”

“Is there a way to patch a loyalty challenge instead of replacing it?”

Tell an agent

Patch just the changed fields on challenge {challengeId}.

Partially update loyalty challenge {challengeId}.

GET /loyalty/metadata/challenges List loyalty challenges · Retrieve all Challenges with filtering and sorting #

Ask an LLM

“Which loyalty challenges have we set up in this sandbox?”

“Can I filter and sort the list of loyalty challenges by property?”

Tell an agent

List all loyalty challenges.

Show {limit} challenges matching {property}, ordered by {orderby}.

POST /loyalty/metadata/challenges Create a loyalty challenge · Create a Challenge #

Ask an LLM

“How do I set up a new loyalty challenge for customers to complete?”

“Can a new challenge require only some of its tasks to be completed?”

Tell an agent

Create a loyalty challenge named {name} from {startDate} to {endDate}.

Create challenge {name} with tasks {tasks}, needing {tasksToComplete} completed, reward {reward}.

POST /loyalty/metadata/challenges/{challengeId}/unpublish Unpublish a loyalty challenge · Unpublish a Challenge and make it unavailable to your customers #

Ask an LLM

“How can I take a live loyalty challenge away from customers?”

“Can I pull a published challenge without deleting it?”

Tell an agent

Unpublish challenge {challengeId}.

Make challenge {challengeId} unavailable to customers.

POST /loyalty/metadata/challenges/{challengeId}/publish Publish a loyalty challenge to customers · Publish a Challenge and make it available to your customers #

Ask an LLM

“What makes a loyalty challenge go live for customers?”

“Can I dry-run publishing a challenge just to check it for errors?”

Tell an agent

Publish challenge {challengeId}.

Validate challenge {challengeId} for publishing with dry-run {dryRun}.

POST /loyalty/metadata/challenges/{challengeId}/duplicate Duplicate a loyalty challenge · Duplicate a challenge including journey metadata and campaigns #

Ask an LLM

“Can I clone an existing loyalty challenge including its journey and campaigns?”

“What's the fastest way to make a copy of a challenge as a starting point?”

Tell an agent

Duplicate challenge {challengeId}.

Make a copy of loyalty challenge {challengeId} with its journey metadata.

POST /loyalty/metadata/challenges/{challengeId}/archive Archive a loyalty challenge · Archive a Challenge. Once in this state, the challenge can only be deleted #

Ask an LLM

“What can I still do with a loyalty challenge after it's archived?”

“Can I retire a challenge without deleting it right away?”

Tell an agent destructive · confirm first

Archive challenge {challengeId}.

Retire loyalty challenge {challengeId} into the archived state.

POST /loyalty/metadata/challenges/initialize Initialize shell journeys and challenges · Initialize shell journey & challenges #

Ask an LLM

“How do I bootstrap the shell journey and challenges for loyalty in a new sandbox?”

“Is there a setup call that initializes loyalty challenges before I create any?”

Tell an agent

Initialize the shell journey and challenges for loyalty.

Set up the starter loyalty challenge shells in sandbox {sandboxId}.

Adobe Suite Challenges API

Operations 11

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification