Submit answers

Staging

https://testserver.loyi.io/public/api

POST

/quest/{id}/submit-answers

Quest

Submits user answers for the a quest of type quiz or
questionnaire. Sending this request again will re-evalute
the answers and update the status of the user's quiz.
Questionnaires always return a status of passed once the answers
have been submitted.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

string <uuid>

required

Quest ID

Header Params

Origin

string

required

The value must be one of the whitelisted domains. You can whitelist domain URLs on your Loyi dashboard.

Default:

<WHITELISTED_URL>

Example:

https://example.com

Body Params application/json

userId

string <uuid>

required

ID of the user that submitted the answers.

answers

array[object (QuizAnswer) {3}]

required

Answers that the user has provided for the quiz or questionnaire.

questionId

string <uuid>

required

ID of the question that the answer belongs to

choiceId

string <uuid>

optional

ID of the choice that represents the answer

value

string

optional

Value of the answer.

Example

{
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "answers": [
        {
            "questionId": "12345678-1234-1234-1234-123456789012",
            "choiceId": "12345678-1234-1234-1234-123456789013"
        },
        {
            "questionId": "12345678-1234-1234-1234-123456789019",
            "value": "lorum ipsum dolor sit amet"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://testserver.loyi.io/public/api/quest//submit-answers' \
--header 'Origin;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "answers": [
        {
            "questionId": "12345678-1234-1234-1234-123456789012",
            "choiceId": "12345678-1234-1234-1234-123456789013"
        },
        {
            "questionId": "12345678-1234-1234-1234-123456789019",
            "value": "lorum ipsum dolor sit amet"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

userId

string <uuid>

required

questId

string <uuid>

required

result

enum<string>

required

Allowed values:

passedfailed

submittedAt

string <date-time>

required

Date when the answers were submitted.

Example

{
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "questId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "passed",
    "submittedAt": "2022-01-01T00:00:00.000Z"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-19 21:23:41

Accept quest

Get answers