Start a new survey participation

POST

api/v1/user/{userkey}/surveys

Start a New Survey Participation

This endpoint is used to initiate a new participation for a user in a survey challenge.

This endpoint does not submit answers.

It only initializes the survey session. Answers must be submitted using the dedicated Submit Survey Answers endpoint.

Info

The created participation will remain in-progress until it is either completed or expired

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'api/v1/user/{{user-key}}/surveys' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "surveyId": "e1acdc8b-e09c-4d4e-87e8-5361cc1685c0"
}'

Response Example

{
    "id": "b7a2ca72-b490-4fba-8ced-f26196d4dee4",
    "surveyId": "e1acdc8b-e09c-4d4e-87e8-5361cc1685c0",
    "userKey": "1765132434113",
    "companyId": "c8e815c6-5d28-489e-a0eb-b0aa735b8c57",
    "status": 1,
    "startedAt": "2025-12-23T16:29:50.5586124Z",
    "completedAt": null,
    "updatedDate": "2025-12-23T16:29:50.5863872Z",
    "createdDate": "2025-12-23T16:29:50.5863872Z",
    "surveyName": "Test survey Name",
    "surveyDescription": "Test survey description ",
    "surveyStartDate": "2025-12-23T16:14:16.236Z",
    "surveyEndDate": null,
    "totalQuestions": 3,
    "answeredQuestions": 0,
    "progressPercentage": 0,
    "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": []
}

Modified at 2025-12-23 20:48:30

Get available surveys for user

Get detailed user participation

Start a new survey participation