Skip to main content
POST
/
studies
/
{studyId}
/
screener
/
questions
Create a screener question
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/screener/questions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "template",
  "questionTemplateId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isRequired": true
}
'
{
  "category": "simple",
  "name": "<string>",
  "isRequired": true,
  "id": "<string>",
  "workspaceId": "<string>",
  "description": "<string>",
  "mappedToPropertyId": "<string>",
  "questionTemplateId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
studyId
string
required

Body

application/json

A single question to append to the screener, discriminated by category

​
category
enum<string>
required
Available options:
template
​
questionTemplateId
string
required

The id of the workspace question template to instantiate

​
name
string

Overrides the template question prompt

​
description
string

Overrides the template question helper text

​
isRequired
boolean

Overrides whether a response is required

Response

The created question

A screener question. Template-sourced questions are returned expanded into their concrete category.

​
category
enum<string>
required
Available options:
simple
​
type
enum<string>
required

Whether the question collects short text, long text, a date, or a number

Available options:
SHORT_FORM,
LONG_FORM,
DATE,
NUMBER
​
name
string
required

The question prompt

​
isRequired
boolean
default:true
required

Whether a response is required before the screener can be submitted

​
id
string
required

The question id

​
workspaceId
string
required

The workspace that owns the question

​
description
string

Optional helper text shown beneath the question prompt

​
mappedToPropertyId
string

Map the response to a person property

​
questionTemplateId
string

Present for questions created from a template