Start challenge for user

Start a challenge or new attempt for the authenticated user. Returns error if challenge is already in progress.

POST /challenges/{challengeId}/start

Start challenge for user

cURL

curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/integration/challenges/{challengeId}/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "communityId": "<string>"
}
'

200

{
  "success": true
}

Authorizations

x-api-token · string · header · required

Headers

x-language · string

The language to return the challenge progress in. If not provided, the default language for the organisation will be used.

Path Parameters

challengeId · string · required

The ID of the challenge to start

Body

application/json

communityId · string

The ID of the community where the challenge is being started from. Used for cross-community challenges to track which community the user is engaging with.

Response

200

application/json

Successful response

success · boolean · required