Skip to main content
PATCH
/
studies
/
{studyId}
/
screener
Update a screener's top-level properties
curl --request PATCH \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/screener \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "showSchedulerToQualified": true,
  "qualifyByDefault": true
}
'
{
  "id": "<string>",
  "workspaceId": "<string>",
  "studyId": "<string>",
  "showSchedulerToQualified": true,
  "qualifyByDefault": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "questions": [
    {
      "category": "simple",
      "name": "<string>",
      "isRequired": true,
      "id": "<string>",
      "workspaceId": "<string>",
      "description": "<string>",
      "mappedToPropertyId": "<string>",
      "questionTemplateId": "<string>"
    }
  ],
  "externalSurveyId": "<string>",
  "surveyMonkeyCollectorId": "<string>",
  "externalSurveySetupErrorCode": "<string>",
  "externalSurveySetupUpdatedAt": "2023-11-07T05:31:56Z",
  "customLinkUrl": "<string>",
  "customLinkTokensJson": "<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

Update a screener's top-level properties. Only the provided fields change; question updates must go through PUT.

showSchedulerToQualified
boolean

Show the interview scheduler to respondents who qualify

qualifyByDefault
boolean

Qualify respondents unless a rule disqualifies them

Response

The updated screener

A screener with its top-level properties and all questions

id
string
required

The screener id

workspaceId
string
required

The workspace that owns the screener

studyId
string
required

The study the screener belongs to

type
enum<string>
required

The type of screener

Available options:
RALLY,
SURVEY_MONKEY,
TYPEFORM,
QUALTRICS,
CUSTOM_LINK
showSchedulerToQualified
boolean
required

Whether the interview scheduler is shown to respondents who qualify

qualifyByDefault
boolean
required

Whether respondents qualify unless a rule disqualifies them

createdAt
string<date-time>
required

When the screener was created (ISO 8601)

updatedAt
string<date-time>
required

When the screener was last updated (ISO 8601)

questions
object[]
required

The screener questions, in display order

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

externalSurveyId
string

The id of the linked external survey, when the screener uses one

surveyMonkeyCollectorId
string

The SurveyMonkey collector id, when the screener uses a SurveyMonkey survey

externalSurveySetupStatus
enum<string>

Setup status of an external survey screener

Available options:
IN_PROGRESS,
READY,
FAILED
externalSurveySetupErrorCode
string

An error code describing why external survey setup failed, when applicable

externalSurveySetupUpdatedAt
string<date-time>

When the external survey setup status last changed (ISO 8601)

The custom link respondents use to take an externally hosted screener

JSON describing the query parameters appended to the custom link