Adobe Suite Challenge Controller API

The challenge-controller API from Adobe Suite — 3 operation(s) for challenge-controller.

Documentation GitHub OpenAPI

Business capability

Loyalty & Retention Management BC-420.40

Operations 3

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

POST /loyalty/challenges/{profileId}/withdraw Withdraw a profile from loyalty challenges · Bulk withdraw #

Ask an LLM

“How do I pull a loyalty member out of several challenges at once?”

“Can I withdraw a profile from only specific challenges by ID?”

Tell an agent destructive · confirm first

Withdraw profile {profileId} from challenges {idList}.

Remove member {profileId} from the listed loyalty challenges {idList}.

POST /loyalty/challenges/state Get a profile's active challenge state · Active challenge state by profile with payload #

Ask an LLM

“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?”

Tell an agent

Get the active challenge state for profile {pid}.

Show challenge progress for profile {pid} in test mode {test}.

POST /loyalty/challenges/signup Sign a profile up for loyalty challenges · Bulk signup #

Ask an LLM

“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?”

Tell an agent

Sign profile {profileId} up for challenges {idList}.

Enroll member {profileId} in these loyalty challenges: {idList}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/adobe-suite:adobe-suite-challenge-controller-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AJO Customer Loyalty Challenge State Challenge Controller…
  description: 'APIs for managing AJO Customer Loyalty Challenge State.


    **Related documentation:** See Loyalty challenges in Journey Optimizer documentation.


    **Required headers:** All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information, see the authentication tutorial.'
  contact:
    url: http://adobe.com
  version: 1.1.0
servers:
- url: http://localhost:8080
  description: Local
- url: https://platform-stage-va7.adobe.io/ajo/
  description: Stage
- url: https://platform-va7.adobe.io/ajo/
  description: Prod
tags:
- name: challenge-controller
paths:
  /loyalty/challenges/{profileId}/withdraw:
    post:
      tags:
      - challenge-controller
      operationId: bulkWithdraw
      parameters:
      - name: x-request-id
        in: header
        required: false
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
      - name: profileId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkWithdraw'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkWithdrawResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '409':
          description: Resource conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
      summary: Bulk withdraw
      x-summary-source: derived
  /loyalty/challenges/state:
    post:
      tags:
      - challenge-controller
      operationId: activeChallengeStateByProfileWithPayload
      parameters:
      - name: x-request-id
        in: header
        required: false
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        required: true
        schema:
          type: string
      - name: test
        in: query
        description: True if running the challenge as a test
        required: false
        schema:
          type: boolean
          default: false
      - name: v
        in: query
        description: Version of the response
        required: false
        schema:
          type: string
          default: 2
      - name: pid
        in: query
        description: Profile Id of the Loyalty guest
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonNode'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '409':
          description: Resource conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
      summary: Active challenge state by profile with payload
      x-summary-source: derived
  /loyalty/challenges/signup:
    post:
      tags:
      - challenge-controller
      operationId: bulkSignup
      parameters:
      - name: x-request-id
        in: header
        required: false
        schema:
          type: string
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkSignup'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkSignupResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '409':
          description: Resource conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProblemDetail'
      summary: Bulk signup
      x-summary-source: derived
components:
  schemas:
    BulkSignupResult:
      type: object
      properties:
        challengeId:
          type: string
        status:
          type: integer
          format: int32
        title:
          type: string
        error_code:
          type: string
        message:
          type: string
    CustomProblemDetail:
      type: object
      properties:
        error_code:
          type: string
        message:
          type: string
        title:
          type: string
        status:
          type: integer
          format: int32
        instance:
          type: string
          format: uri
        method:
          type: string
        time:
          type: string
        requestId:
          type: string
    BulkSignupResponse:
      type: object
      properties:
        signupResponse:
          type: array
          items:
            $ref: '#/components/schemas/BulkSignupResult'
    BulkWithdraw:
      type: object
      properties:
        idList:
          uniqueItems: true
          type: array
          items:
            type: string
    JsonNode:
      type: object
    BulkWithdrawResponse:
      type: object
      properties:
        withdrawResponse:
          type: array
          items:
            $ref: '#/components/schemas/BulkSignupResult'
    BulkSignup:
      type: object
      properties:
        profileId:
          type: string
        idList:
          uniqueItems: true
          type: array
          items:
            type: string

Adobe Suite Challenge Controller API

Operations 3

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification