On this page: Learn how to use the Loyalty Challenges REST APIs to programmatically create and manage challenges, and to query and update challenge participation state for individual profiles.
Quick access quick-access
Two REST APIs are available for Loyalty Challenges:
- Loyalty challenge metadata API — Create, retrieve, update, publish, archive, and duplicate challenges programmatically.
- Loyalty challenge state API — Query and update challenge participation state for individual profiles.
Loyalty challenge metadata API metadata-api
The Loyalty challenge metadata API lets you manage the full lifecycle of challenges outside the Journey Optimizer UI. Use it to automate challenge operations or integrate loyalty program management into your own tools and workflows. You can, for example, create, publish, and archive challenges, retrieve all challenges with filtering and sorting, or duplicate an existing challenge including its journey metadata and campaigns.
➡️ Loyalty challenge metadata API reference
Loyalty challenge state API state-api
The Loyalty challenge state API lets you interact with challenge participation records at the profile level. Use it to query a profile’s current participation status, progress, and task completion — for example, retrieve all challenge participation records for a profile, check the state of a specific task within a challenge, or withdraw a profile from one or more challenges.
➡️ Loyalty challenge state API reference
Authentication authentication
All Loyalty Challenges API calls require the following headers:
Authorizationx-gw-ims-org-idx-api-keyx-sandbox-nameFollow the authentication tutorial to retrieve these credentials.