Submit completed survey
PUT
api/v1/user/{userkey}/surveys/{userSurveyId}
Complete Survey Participation
Info
Description
It performs final validation on all submitted answers, persists the results, and transitions the survey to a completed state.
If the survey is linked to a reward system, rewards are calculated and distributed automatically.
Usage Examples
Path Parameters
| Name | Type | Description |
|---|---|---|
userKey | string | Unique identifier of the user (derived from authentication context) |
userSurveyId | UUID | Unique identifier of the user survey participation (retrieved from the /mine endpoint) |
Response
Answer Validation Rules
"yes", "no", "true", "false" (case-insensitive)Important
choices field, not the localized label.Validation Rules
Common Errors
| Error Code | Description |
|---|---|
USER_SURVEY_NOT_FOUND | Invalid user survey ID or access denied |
SURVEY_ALREADY_COMPLETED | Survey participation has already been submitted |
INVALID_ANSWER_FORMAT | One or more answers do not match question type requirements |
QUESTION_NOT_FOUND_IN_SURVEY | A submitted question does not belong to the survey |
Request
Path Params
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'api/v1/user/{{user-key}}/surveys/{{survey_id}}' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"answers": [
{
"questionId": "f72d1e11-e3c3-426f-b81e-f1305ac41e79",
"answer": "true"
},
{
"questionId": "df41a808-279c-4843-a5de-aafc51cacdd3",
"answer": "Choice 1"
},
{
"questionId": "690e5f3f-cc79-471f-bc74-f1fd914154d6",
"answer": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur eget faucibus diam"
}
]
}'Response Response Example
{
"id": "b7a2ca72-b490-4fba-8ced-f26196d4dee4",
"surveyId": "e1acdc8b-e09c-4d4e-87e8-5361cc1685c0",
"userKey": "1765132434113",
"companyId": "c8e815c6-5d28-489e-a0eb-b0aa735b8c57",
"status": 2,
"startedAt": "2025-12-23T16:29:50.558612Z",
"completedAt": "2025-12-23T21:48:50.7044355Z",
"updatedDate": "2025-12-23T21:48:50.8352408Z",
"createdDate": "2025-12-23T16:29:50.586387Z",
"surveyName": "Test survey Name",
"surveyDescription": "Test survey description ",
"surveyStartDate": "2025-12-23T16:14:16.236Z",
"surveyEndDate": null,
"totalQuestions": 3,
"answeredQuestions": 3,
"progressPercentage": 100,
"questions": [
{
"id": "f72d1e11-e3c3-426f-b81e-f1305ac41e79",
"surveyId": "e1acdc8b-e09c-4d4e-87e8-5361cc1685c0",
"questionType": 1,
"question": "Test Yes no question",
"orderQuestion": 1,
"choices": [
"Yes",
"No"
],
"createdDate": "2025-12-23T16:14:16.954642Z",
"updatedDate": "2025-12-23T16:14:16.954642Z",
"localizedQuestions": {
"ar": "تجربة اسئلة نعم ولا",
"en": "Test Yes no question"
},
"localizedChoices": {
"ar": [
"نعم",
"لا"
],
"en": [
"Yes",
"No"
]
}
},
{
"id": "df41a808-279c-4843-a5de-aafc51cacdd3",
"surveyId": "e1acdc8b-e09c-4d4e-87e8-5361cc1685c0",
"questionType": 2,
"question": "Test Multiple choices question",
"orderQuestion": 2,
"choices": [
"Choice 1",
"Choice 2"
],
"createdDate": "2025-12-23T16:14:16.954727Z",
"updatedDate": "2025-12-23T16:14:16.954727Z",
"localizedQuestions": {
"ar": "تجربة اسئلة الخيارات المتعددة",
"en": "Test Multiple choices question"
},
"localizedChoices": {
"ar": [
"خيار الاول",
"خيار ٢"
],
"en": [
"Choice 1",
"Choice 2"
]
}
},
{
"id": "690e5f3f-cc79-471f-bc74-f1fd914154d6",
"surveyId": "e1acdc8b-e09c-4d4e-87e8-5361cc1685c0",
"questionType": 3,
"question": "Test Open-ended question",
"orderQuestion": 3,
"choices": [],
"createdDate": "2025-12-23T16:14:16.954735Z",
"updatedDate": "2025-12-23T16:14:16.954735Z",
"localizedQuestions": {
"ar": "تجربة السؤال المفتوح",
"en": "Test Open-ended question"
},
"localizedChoices": null
}
],
"answers": [
{
"id": "064771d6-c990-4c53-b224-7a0af6162afb",
"questionId": "f72d1e11-e3c3-426f-b81e-f1305ac41e79",
"question": "Test Yes no question",
"answer": "true",
"answeredAt": "0001-01-01T00:00:00"
},
{
"id": "551630e5-8292-4bc1-afcd-44cba2edc0f7",
"questionId": "df41a808-279c-4843-a5de-aafc51cacdd3",
"question": "Test Multiple choices question",
"answer": "Choice 1",
"answeredAt": "0001-01-01T00:00:00"
},
{
"id": "e7aa8a6e-b677-49de-abbe-f1a5ef573353",
"questionId": "690e5f3f-cc79-471f-bc74-f1fd914154d6",
"question": "Test Open-ended question",
"answer": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur eget faucibus diam",
"answeredAt": "0001-01-01T00:00:00"
}
]
}Modified at 2025-12-23 22:05:23