Skip to main content
POST
/
challenges
/
{challengeId}
/
start
Start challenge for user
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>"
}
'
{
  "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

Successful response

success
boolean
required