Screener

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. Not available for survey studies.

put/studies/{studyId}/screener

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/studies/{studyId}/screener
  • Auth: HTTP bearer

Path parameters

studyIdstring required

Request body

showSchedulerToQualifiedboolean

Show the interview scheduler to respondents who qualify. Omitted values reset to false (full replace).

qualifyByDefaultboolean

Qualify respondents unless a rule disqualifies them. Omitted values reset to false (full replace).

Response

The replaced screener

idstring required

The screener id

workspaceIdstring required

The workspace that owns the screener

studyIdstring required

The study the screener belongs to

type'RALLY' | 'SURVEY_MONKEY' | 'TYPEFORM' | 'QUALTRICS' | 'CUSTOM_LINK' required

The type of screener

showSchedulerToQualifiedboolean required

Whether the interview scheduler is shown to respondents who qualify

qualifyByDefaultboolean required

Whether respondents qualify unless a rule disqualifies them

externalSurveyIdstring

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

surveyMonkeyCollectorIdstring

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

externalSurveySetupStatus'IN_PROGRESS' | 'READY' | 'FAILED'

Setup status of an external survey screener

externalSurveySetupErrorCodestring

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

externalSurveySetupUpdatedAtstring date-time

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

customLinkUrlstring

The custom link respondents use to take an externally hosted screener

customLinkTokensJsonstring

JSON describing the query parameters appended to the custom link

createdAtstring date-time required

When the screener was created (ISO 8601)

updatedAtstring date-time required

When the screener was last updated (ISO 8601)

Changes

No recorded changes to this operation across all 1 revision of this API.