Create survey

POST

https://api.prolific.com/api/v1/surveys/

POST

/api/v1/surveys/

curl -X POST https://api.prolific.com/api/v1/surveys/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "researcher_id": "7172727272",
  "title": "A survey with questions",
  "questions": [
    {
      "answers": [
        {
          "value": "Potato",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "title": "What is your favourite root vegetable?",
      "type": "single",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}'

{
  "researcher_id": "7172727272",
  "title": "A survey about vegetables",
  "_id": "string",
  "date_created": "2022-05-27T08:43:12",
  "date_modified": "2022-05-27T08:43:12",
  "sections": [
    {
      "questions": [
        {
          "answers": [
            {
              "value": "Potato",
              "id": "string"
            }
          ],
          "title": "What is your favourite root vegetable?",
          "type": "single",
          "id": "string"
        }
      ],
      "title": "Root vegetables",
      "id": "string"
    }
  ],
  "questions": [
    {
      "answers": [
        {
          "value": "Potato",
          "id": "string"
        }
      ],
      "title": "What is your favourite root vegetable?",
      "type": "single",
      "id": "string"
    }
  ]
}

You can create a survey with either sections -> questions or just questions. This allows you to decide how much flexibility you want in your survey design. However, if you want to render the survey in the Prolific Application, you must use sections.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Request

This endpoint expects an object.

researcher_idstringRequired

The Prolific researcher ID.

titlestringRequired

The survey title.

sectionslist of objectsOptional

An array of sections in the survey, or use questions.

questionslist of objectsOptional

An array of questions in the survey, or use sections.

Response

Successful Response

researcher_idstring

The Prolific researcher ID.

titlestring

The survey title.

_idstringOptional

Auto generated by the system.

date_createddatetimeOptional

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

date_modifieddatetimeOptional

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

sectionslist of objectsOptional

Optional: An array of sections in the survey, otherwise questions will be defined.

questionslist of objectsOptional

Optional: An array of questions in the survey, otherwise sections will be defined.

Errors

4XX

Client Request Error