Core Setup

Create multiple screener questions

This endpoint will replace all screener questions with the list in the body.

Screener questions are limited to a maximum of 40 per project.

Uid is optional. If not provided, a new uid will be generated for the question.

Radio Question skip logic: goToQuestionUid is required.

Checkbox Question skip logic: answerUid of the checkbox question and goToQuestionUid of question to navigate to are required.

To use bulk screener endpoint, send the list of questions in the body:

Option 1: Send bulk questions including uids and skip logic (see skip logic requirements above) from your end. We will process and return the response with the uids.

Option 2: This option has 2 steps:

2.1 PUT request: Create bulk questions without skip logic.

2.2 PUT request: Use the generated uids from the above response to update the skip logic for bulk questions. Please ensure you refer the same uids generated in the response.

PUT

projects

{projectId}

screener-questions

bulk

Create multiple screener questions

curl --request PUT \
  --url https://api-staging.respondent.io/v1/projects/{projectId}/screener-questions/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '[
  {
    "text": "<string>",
    "isRequired": true,
    "skipLogic": true,
    "includeOtherOption": true,
    "questionType": "radio",
    "id": "<string>",
    "uid": "<string>",
    "answers": [
      {
        "text": "<string>",
        "goToQuestionUid": "<string>",
        "isOther": true,
        "answerValue": 1,
        "id": "<string>",
        "uid": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "isEnd": false,
    "warnings": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
]'

[
  {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "questionType": "radio",
    "uid": "<string>",
    "text": "<string>",
    "answers": [
      {
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "uid": "<string>",
        "text": "<string>",
        "answerValue": 123,
        "goToQuestionUid": "<string>",
        "isOther": true,
        "id": "<string>"
      }
    ],
    "isRequired": true,
    "skipLogic": true,
    "includeOtherOption": true,
    "isEnd": true,
    "logic": {
      "answerUid": "<string>",
      "goToQuestionUid": "<string>",
      "skipLogicType": {
        "id": 1,
        "text": "Selected"
      },
      "multipleAnswers": [
        {
          "answer": "<string>",
          "logicType": {
            "id": 1,
            "text": "Selected"
          }
        }
      ],
      "multipleAnswersBoolType": {
        "id": 1,
        "text": "AND"
      }
    },
    "minValue": 123,
    "maxValue": 123,
    "step": 123,
    "order": 123,
    "warnings": [
      "<string>"
    ],
    "id": "<string>"
  }
]

Headers

x-api-key

string

required

x-api-secret

string

required

Path Parameters

projectId

string

required

Body

application/json · (Radio Question · object | Checkbox Question · object | Textbox Question · object | Slider Scale Question · object)[]

Radio Question
Checkbox Question
Textbox Question
Slider Scale Question

text

string

required

questionType

enum<string>

required

Available options:

radio

answers

object[]

required

Show child attributes

isRequired

boolean

skipLogic

boolean

includeOtherOption

boolean

string<ObjectId>

uid

string

isEnd

boolean

default:false

warnings

string[]

createdAt

string<date-time>

Response

200 - application/json

createdAt

string

required

text

string

required

minValue

number

required

maxValue

number

required

step

number

required

string

required

updatedAt

string

questionType

enum<string>

Available options:

radio,

multiLineTextbox,

checkbox,

singleLineTextbox,

numericBox,

sliderScale

uid

string

answers

object[]

Show child attributes

isRequired

boolean

skipLogic

boolean

includeOtherOption

boolean

isEnd

boolean

logic

object

Show child attributes

order

number

warnings

string[]

Publish a projectPublishes a Project. Note: publicDescription field is required when publishing.

⌘I

Create multiple screener questions

curl --request PUT \
  --url https://api-staging.respondent.io/v1/projects/{projectId}/screener-questions/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '[
  {
    "text": "<string>",
    "isRequired": true,
    "skipLogic": true,
    "includeOtherOption": true,
    "questionType": "radio",
    "id": "<string>",
    "uid": "<string>",
    "answers": [
      {
        "text": "<string>",
        "goToQuestionUid": "<string>",
        "isOther": true,
        "answerValue": 1,
        "id": "<string>",
        "uid": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "isEnd": false,
    "warnings": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
]'

[
  {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "questionType": "radio",
    "uid": "<string>",
    "text": "<string>",
    "answers": [
      {
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "uid": "<string>",
        "text": "<string>",
        "answerValue": 123,
        "goToQuestionUid": "<string>",
        "isOther": true,
        "id": "<string>"
      }
    ],
    "isRequired": true,
    "skipLogic": true,
    "includeOtherOption": true,
    "isEnd": true,
    "logic": {
      "answerUid": "<string>",
      "goToQuestionUid": "<string>",
      "skipLogicType": {
        "id": 1,
        "text": "Selected"
      },
      "multipleAnswers": [
        {
          "answer": "<string>",
          "logicType": {
            "id": 1,
            "text": "Selected"
          }
        }
      ],
      "multipleAnswersBoolType": {
        "id": 1,
        "text": "AND"
      }
    },
    "minValue": 123,
    "maxValue": 123,
    "step": 123,
    "order": 123,
    "warnings": [
      "<string>"
    ],
    "id": "<string>"
  }
]

Getting started

Project Setup

Screener Response Handling

Messaging

Lookup and Reference Data

Webhooks

Team Tools

Create multiple screener questions

Headers

Path Parameters

Body

Response