Answer a quest task

POST /v1/player/quests/answer · for player session

Use it when the player types or picks an answer to a task whose action is answer or rate. CEEJAY validates it using the rules the Discord form uses: text must contain the required content and reach its minLength, a number must fall between min and max, and a rating must be a whole number from 1 to scale. The request needs the game loop. For the three conditions (game loop enabled for the game, member consent, server membership) and the error each returns, see What has to be true first.

Body parameters

Returns

The response is the same as Verify a quest task: the quest completes when this was its last task, and rewards lists what it granted.

Example

curl -X POST https://ceejay.communitystudios.xyz/api/v1/player/quests/answer \
  -H "Authorization: Bearer $CEEJAY_PLAYER_SESSION" \
  -H "Content-Type: application/json" \
  -d '{
    "questId": 12,
    "taskId": 42,
    "answer": "Rugby Manager, every weekend"
  }'

The TypeScript example uses connect.hub.answerQuestTask from the Connect client in the TypeScript SDK. The player must be connected first: the client manages and refreshes the player session. It returns the data of the response below.

{
  "success": true,
  "data": {
    "questId": 12,
    "taskId": 42,
    "verified": true,
    "questCompleted": false,
    "tasksDone": 2,
    "taskCount": 5,
    "rewards": null
  }
}

A wrong answer, and a bad one

An incorrect answer, such as text without the required content or a number the task does not accept, returns 409 with the code quest_task_not_done, and message says what is missing. An answer that is empty, too long, shorter than the task's minLength or outside the rating scale returns 400 with field: "answer". For text that is too short or a rating outside the scale, the message matches the Discord form's message.

A task that the community's team reviews is rejected before anything is written, with quest_task_unavailable and the reason not_for_games: a game never submits an answer for review. Repeating the request for a completed task returns already_done, so the request is safe to repeat and takes no key. CEEJAY does not send the member a direct message.

Limits

20 writes a minute for one player session, shared by Start, Verify and Answer a quest task, Buy a shop item, Claim an item and Check in. The three X-RateLimit headers report that count. Every request made with a player session also counts toward 140 a minute. See Rate limits. Over a limit the response is 429 with the code rate_limited, retryAfter and a Retry-After header.

Errors

Every error body also includes requestId, and a 400 with the code bad_request identifies the invalid field in field. Match on code; message text can change.

The errors every request of a game shares (the key, the state of the game, the origin, 405, 429, 500) are on the Errors page, and the errors specific to the game loop are under Codes of the game loop.