Create response | Prolific API

import requests
url = "https://api.prolific.com/api/v1/surveys/survey_id/responses/"
payload = {
    "participant_id": "62908f0b98a55b36ac68b992",
    "submission_id": "62908f0b98a55b36ac68b992",
    "sections": [
        {
            "questions": [
                {
                    "answers": [
                        {
                            "answer_id": "8bde0c5f-235e-41e6-bf82-b73e92852ac8",
                            "value": "Potato"
                        }
                    ],
                    "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
                    "question_title": "What is your favourite root vegetable?"
                }
            ],
            "section_id": "f5e5c4dc-7d2e-40f1-a895-9bb2f8703fd8"
        }
    ]
}
headers = {
    "Authorization": "Token <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "participant_id": "62908f0b98a55b36ac68b992",
  "submission_id": "62908f0b98a55b36ac68b992",
  "_id": "62fccc6ea792097ae2145ca4",
  "sections": [
    {
      "questions": [
        {
          "answers": [
            {
              "answer_id": "8bde0c5f-235e-41e6-bf82-b73e92852ac8",
              "value": "Potato"
            }
          ],
          "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
          "question_title": "What is your favourite root vegetable?"
        }
      ],
      "section_id": "f5e5c4dc-7d2e-40f1-a895-9bb2f8703fd8"
    }
  ]
}

Create a Response for a survey.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

survey_idstringRequired

Request

This endpoint expects an object.

participant_idstringRequired

The Prolific participant ID.

submission_idstringRequired

The Prolific submission ID.

sectionslist of objectsOptional

An array of sections from the survey, otherwise use questions.

questionslist of objectsOptional

An array of questions from the survey, otherwise use sections.

Response

Successful Response

participant_idstring

The Prolific participant ID.

submission_idstring

The Prolific submission ID.

_idstring or null

date_createddatetime or null

The date/time the response was created (UTC).

date_modifieddatetime or null

The date/time the response was modified (UTC).

sectionslist of objects or null

An array of sections from the survey, otherwise questions.

questionslist of objects or null

An array of questions from the survey, otherwise sections.

Authentication

Path parameters

Request

Response

Errors