Update a screener's top-level properties
Update the top-level properties of a draft study’s screener. Only the provided fields change. Question updates must go through PUT /studies//screener. 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
Response
The updated 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