Replace a study's screener
Completely replace (upsert) the screener for a draft study. The entire screener configuration must be sent: question ids are regenerated on every call and omitted top-level properties reset to their defaults. Creates the screener (and enables the study’s includeScreener flag) when the study has none. Only Rally screeners can be managed via the API.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
The complete screener configuration. PUT fully replaces the existing screener: question ids are regenerated and omitted top-level properties reset to their defaults.
The ordered list of screener questions
1 - 50 elementsA single question to create, discriminated by category
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show the interview scheduler to respondents who qualify. Omitted values reset to false (full replace).
Qualify respondents unless a rule disqualifies them. Omitted values reset to false (full replace).
Response
The replaced screener
A screener with its top-level properties and all questions
The screener id
The workspace that owns the screener
The study the screener belongs to
The type of screener
RALLY, SURVEY_MONKEY, TYPEFORM, QUALTRICS, CUSTOM_LINK Whether the interview scheduler is shown to respondents who qualify
Whether respondents qualify unless a rule disqualifies them
When the screener was created (ISO 8601)
When the screener was last updated (ISO 8601)
The screener questions, in display order
A screener question. Template-sourced questions are returned expanded into their concrete category.
- Option 1
- Option 2
- Option 3
- Option 4
The id of the linked external survey, when the screener uses one
The SurveyMonkey collector id, when the screener uses a SurveyMonkey survey
Setup status of an external survey screener
IN_PROGRESS, READY, FAILED An error code describing why external survey setup failed, when applicable
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