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.
The complete screener configuration. PUT fully replaces the existing screener: question ids are regenerated and omitted top-level properties reset to their defaults.
JSON describing the query parameters appended to the custom link
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Rally Developer Docs","colors":{"primary":"#101014","light":"#D8E1FF","dark":"#101014"},"favicon":"https://mintcdn.com/rallyuxr-21/xXqJ3k5MbwVd7Nk6/favicon.svg?fit=max\u0026auto=format\u0026n=xXqJ3k5MbwVd7Nk6\u0026q=85\u0026s=5c3dd8a9ea7472c86c7e3fd64bd7fbdc","logo":{"light":"https://mintcdn.com/rallyuxr-21/xXqJ3k5MbwVd7Nk6/logo/light.svg?fit=max\u0026auto=format\u0026n=xXqJ3k5MbwVd7Nk6\u0026q=85\u0026s=c3a14e4fbdb0423495b2ccff80c58308","dark":"https://mintcdn.com/rallyuxr-21/xXqJ3k5MbwVd7Nk6/logo/dark.svg?fit=max\u0026auto=format\u0026n=xXqJ3k5MbwVd7Nk6\u0026q=85\u0026s=c7506ea8e6e4c2394cd75c808b42ec10"},"navbar":{"links":[{"label":"Support","href":"support@rallyuxr.com"}],"primary":null},"footer":{"socials":{"x":"https://x.com/rallyuxr","linkedin":"https://www.linkedin.com/company/rallyuxr/"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Help Center","href":"https://help.rallyuxr.com/en/","icon":"book-open-cover"},{"anchor":"Blog","href":"https://www.rallyuxr.com/blog","icon":"newspaper"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rallyuxr-21","hasAudioNarration":false,"actualSubdomain":"rallyuxr-21","customDomains":["docs.rallyuxr.com"],"gitSource":{"type":"github","owner":"rallyhq","repo":"rally-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a973bfdbfa36a66868c56dd","collectionId":"db811c51-6929-41a2-a59a-396ef6548f46","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a973bfdbfa36a66868c56dd"},"entitlements":{},"buildId":"6a973bfdbfa36a66868c56dd","clientVersion":"0.0.3962","searchFilterCounts":[{"language":"default","tag":"API Reference","count":79},{"language":"default","tag":"Studies","count":14},{"language":"default","tag":"Person Properties","count":10},{"language":"default","tag":"Incentives","count":9},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Screener","count":8},{"language":"default","tag":"People","count":6},{"language":"default","tag":"Participants","count":5},{"language":"default","tag":"Home","count":3},{"language":"default","tag":"Get Started","count":3}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/screener/replace-a-studys-screener","slug":"/api-reference/screener/replace-a-studys-screener","pageMetadata":{"title":"Replace a study's screener","description":"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.","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi put /studies/{studyId}/screener","href":"/api-reference/screener/replace-a-studys-screener","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"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.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Replace a study's screener","description":"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.","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi put /studies/{studyId}/screener","href":"/api-reference/screener/replace-a-studys-screener","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Screener"],"summary":"Replace a study's screener","description":"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.","security":["cde1283d-a729-4424-acbd-c478ba1b3a2e"],"parameters":["40346610-acc2-4540-b061-227fffe4ff01"],"requestBody":"379a1c19-5461-45de-ac4b-04f9d4e3c142","responses":{"200":"b4c3d5b2-12b5-4777-b5ea-4b2f51befdaf","400":"7ef63d1c-1cfb-4368-a948-d5a60dd9c3ae","401":"40b5d56a-513d-4098-96f4-d65498ad4f9d","403":"4dfbc330-ae94-4b50-9ac6-3b8f1dd956b4","404":"cf59c06b-4099-48db-acf1-c09a2b637baf","409":"98357505-2042-40dd-aafd-71889d3f64ce","429":"02066e74-251f-4f39-9378-62dbad6223bb","500":"c1812238-8b13-4f7c-bf0d-257cd23509d1"},"method":"put","type":"path","servers":["f76dc156-13d8-4704-8eee-b1a1f1f478c2"],"path":"/studies/{studyId}/screener","baseUrlOptions":["https://api.rallyuxr.com/api/public/v1"],"title":"Replace a study's screener","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"40346610-acc2-4540-b061-227fffe4ff01":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"studyId","in":"path"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"questions":{"type":"array","items":{"oneOf":[{"type":"object","description":"A single question to create, discriminated by category","required":["category","questionTemplateId"],"properties":{"category":{"type":"string","enum":["template"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.category","typeLabel":"enum\u003cstring>"},"questionTemplateId":{"type":"string","description":"The id of the workspace question template to instantiate","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.questionTemplateId","typeLabel":"string"},"name":{"type":"string","description":"Overrides the template question prompt","uniqueKey":"questions.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"Overrides the template question helper text","uniqueKey":"questions.items.[INDEX].oneOf.0.description","typeLabel":"string"},"isRequired":{"type":"boolean","description":"Overrides whether a response is required","uniqueKey":"questions.items.[INDEX].oneOf.0.isRequired","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A single question to create, discriminated by category","required":["category","type","name"],"properties":{"category":{"type":"string","enum":["simple"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["SHORT_FORM","LONG_FORM","DATE","NUMBER"],"description":"Whether the question collects short text, long text, a date, or a number","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.name","typeLabel":"string"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.1.description","typeLabel":"string"},"isRequired":{"type":"boolean","default":true,"description":"Whether a response is required before the screener can be submitted","uniqueKey":"questions.items.[INDEX].oneOf.1.isRequired","typeLabel":"boolean"},"mappedToPropertyId":{"type":"string","description":"Map the response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.1.mappedToPropertyId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A single question to create, discriminated by category","required":["category","type","name","options"],"properties":{"category":{"type":"string","enum":["option"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["SINGLE_SELECT","MULTI_SELECT"],"description":"Whether respondents may select one option (SINGLE_SELECT) or several (MULTI_SELECT)","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.name","typeLabel":"string"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The display value of the option","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.options.items.[INDEX].value","typeLabel":"string"},"mappedToPropertyOptionId":{"type":"string","description":"The property option this option maps to. Omit to leave the option unmapped when the question has a mappedToPropertyId.","uniqueKey":"questions.items.[INDEX].oneOf.2.options.items.[INDEX].mappedToPropertyOptionId","typeLabel":"string"}},"required":["value"],"additionalProperties":false,"description":"An option for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.2.options.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":25,"description":"The selectable options, in display order","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.options","typeLabel":"object[]"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.2.description","typeLabel":"string"},"isRequired":{"type":"boolean","default":true,"description":"Whether a response is required before the screener can be submitted","uniqueKey":"questions.items.[INDEX].oneOf.2.isRequired","typeLabel":"boolean"},"rules":{"type":"array","items":{"type":"object","properties":{"operator":{"type":"string","enum":["IS_EXACTLY","DOESNT_EQUAL","INCLUDES_ANY_OF","INCLUDES_ALL_OF","NOT_INCLUDES_ANY_OF"],"description":"The comparison applied by a screener question rule","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"optionValues":{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].optionValues.items.[INDEX]","typeLabel":"string"},"description":"The option values the operator compares against. Must reference question options, or \"OTHER\"/\"NONE\" when enabled.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].optionValues","typeLabel":"string[]"},"action":{"oneOf":[{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type"],"properties":{"type":{"type":"string","enum":["END_SCREENER"],"description":"End the screener when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.0","typeLabel":"object"},{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type","index"],"properties":{"type":{"type":"string","enum":["JUMP"],"description":"Jump to another question when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.1.type","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","description":"The zero-based index of the question to jump to. Must reference a question after this one; use END_SCREENER to route past the last question.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.1.index","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action","typeLabel":"object"},"qualificationLogic":{"type":"string","enum":["QUALIFY","DISQUALIFY"],"description":"Omit for jump or end actions that only route the response","uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].qualificationLogic","typeLabel":"enum\u003cstring>"}},"required":["operator","optionValues"],"additionalProperties":false,"description":"Qualification or skip logic for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX]","typeLabel":"object"},"description":"Qualification or skip logic evaluated against the selected options","uniqueKey":"questions.items.[INDEX].oneOf.2.rules","typeLabel":"object[]"},"mappedToPropertyId":{"type":"string","description":"Map the response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.2.mappedToPropertyId","typeLabel":"string"},"randomizeOrder":{"type":"boolean","default":false,"description":"Randomize the order options are shown to each respondent","uniqueKey":"questions.items.[INDEX].oneOf.2.randomizeOrder","typeLabel":"boolean"},"includeOther":{"type":"boolean","default":false,"description":"Add a free-text \"Other\" option","uniqueKey":"questions.items.[INDEX].oneOf.2.includeOther","typeLabel":"boolean"},"otherDisplayText":{"type":"string","description":"Cannot be supplied unless includeOther is true","uniqueKey":"questions.items.[INDEX].oneOf.2.otherDisplayText","typeLabel":"string"},"includeNoneOfTheAbove":{"type":"boolean","default":false,"description":"Add a \"None of the above\" option","uniqueKey":"questions.items.[INDEX].oneOf.2.includeNoneOfTheAbove","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A single question to create, discriminated by category","required":["category","type","name","options"],"properties":{"category":{"type":"string","enum":["dropdown"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["DROPDOWN"],"description":"A dropdown question type","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.name","typeLabel":"string"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The display value of the option","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.options.items.[INDEX].value","typeLabel":"string"},"mappedToPropertyOptionId":{"type":"string","description":"The property option this option maps to. Omit to leave the option unmapped when the question has a mappedToPropertyId.","uniqueKey":"questions.items.[INDEX].oneOf.3.options.items.[INDEX].mappedToPropertyOptionId","typeLabel":"string"}},"required":["value"],"additionalProperties":false,"description":"An option for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.3.options.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":25,"description":"The selectable options, in display order","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.options","typeLabel":"object[]"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.3.description","typeLabel":"string"},"isRequired":{"type":"boolean","default":true,"description":"Whether a response is required before the screener can be submitted","uniqueKey":"questions.items.[INDEX].oneOf.3.isRequired","typeLabel":"boolean"},"rules":{"type":"array","items":{"type":"object","properties":{"operator":{"type":"string","enum":["IS_EXACTLY","DOESNT_EQUAL","INCLUDES_ANY_OF","INCLUDES_ALL_OF","NOT_INCLUDES_ANY_OF"],"description":"The comparison applied by a screener question rule","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"optionValues":{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].optionValues.items.[INDEX]","typeLabel":"string"},"description":"The option values the operator compares against. Must reference question options, or \"OTHER\"/\"NONE\" when enabled.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].optionValues","typeLabel":"string[]"},"action":{"oneOf":[{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type"],"properties":{"type":{"type":"string","enum":["END_SCREENER"],"description":"End the screener when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].action.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].action.oneOf.0","typeLabel":"object"},{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type","index"],"properties":{"type":{"type":"string","enum":["JUMP"],"description":"Jump to another question when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].action.oneOf.1.type","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","description":"The zero-based index of the question to jump to. Must reference a question after this one; use END_SCREENER to route past the last question.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].action.oneOf.1.index","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].action.oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].action","typeLabel":"object"},"qualificationLogic":{"type":"string","enum":["QUALIFY","DISQUALIFY"],"description":"Omit for jump or end actions that only route the response","uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX].qualificationLogic","typeLabel":"enum\u003cstring>"}},"required":["operator","optionValues"],"additionalProperties":false,"description":"Qualification or skip logic for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.3.rules.items.[INDEX]","typeLabel":"object"},"description":"Qualification or skip logic evaluated against the selected option","uniqueKey":"questions.items.[INDEX].oneOf.3.rules","typeLabel":"object[]"},"mappedToPropertyId":{"type":"string","description":"Map the response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.3.mappedToPropertyId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"A single question to create, discriminated by category","required":["category","type","name","columns","rows"],"properties":{"category":{"type":"string","enum":["matrix"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.4.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["MATRIX"],"description":"A matrix question type","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.4.name","typeLabel":"string"},"columns":{"type":"array","items":{"type":"string","maxLength":40,"uniqueKey":"questions.items.[INDEX].oneOf.4.columns.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":25,"description":"The shared column labels applied to every row","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.4.columns","typeLabel":"string[]"},"rows":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","maxLength":100,"description":"The row label","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.4.rows.items.[INDEX].value","typeLabel":"string"},"mappedToPropertyId":{"type":"string","description":"Map this row's response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.4.rows.items.[INDEX].mappedToPropertyId","typeLabel":"string"},"columnToPropertyOptionId":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"questions.items.[INDEX].oneOf.4.rows.items.[INDEX].columnToPropertyOptionId.additionalProperties","typeLabel":"string"},"description":"Maps a column value to a property option id. Columns missing from this map are left unmapped.","uniqueKey":"questions.items.[INDEX].oneOf.4.rows.items.[INDEX].columnToPropertyOptionId","typeLabel":"object"}},"required":["value"],"additionalProperties":false,"description":"A row of a matrix question","uniqueKey":"questions.items.[INDEX].oneOf.4.rows.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":25,"description":"The matrix rows","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.4.rows","typeLabel":"object[]"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.4.description","typeLabel":"string"},"isRequired":{"type":"boolean","default":true,"description":"Whether a response is required before the screener can be submitted","uniqueKey":"questions.items.[INDEX].oneOf.4.isRequired","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":50,"description":"The ordered list of screener questions","isRequired":true,"uniqueKey":"questions","typeLabel":"object[]"},"showSchedulerToQualified":{"type":"boolean","default":false,"description":"Show the interview scheduler to respondents who qualify. Omitted values reset to false (full replace).","uniqueKey":"showSchedulerToQualified","typeLabel":"boolean"},"qualifyByDefault":{"type":"boolean","default":false,"description":"Qualify respondents unless a rule disqualifies them. Omitted values reset to false (full replace).","uniqueKey":"qualifyByDefault","typeLabel":"boolean"}},"required":["questions"],"additionalProperties":false,"description":"The complete screener configuration. PUT fully replaces the existing screener: question ids are regenerated and omitted top-level properties reset to their defaults.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"questions":[{"category":"template","questionTemplateId":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","isRequired":true}],"showSchedulerToQualified":false,"qualifyByDefault":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b4c3d5b2-12b5-4777-b5ea-4b2f51befdaf":{"description":"The replaced screener","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests the client is allowed to make.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining for the client in the current time window.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Reset":{"description":"The time at which the current time window ends (in Unix timestamp format).","schema":{"type":"integer","format":"int32"}}},"content":{"application/json":{"schema":{"type":"object","description":"A screener with its top-level properties and all questions","required":["questions","id","workspaceId","studyId","type","showSchedulerToQualified","qualifyByDefault","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"The screener id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"workspaceId":{"type":"string","description":"The workspace that owns the screener","isRequired":true,"uniqueKey":"workspaceId","typeLabel":"string"},"studyId":{"type":"string","description":"The study the screener belongs to","isRequired":true,"uniqueKey":"studyId","typeLabel":"string"},"type":{"type":"string","enum":["RALLY","SURVEY_MONKEY","TYPEFORM","QUALTRICS","CUSTOM_LINK"],"description":"The type of screener","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"showSchedulerToQualified":{"type":"boolean","description":"Whether the interview scheduler is shown to respondents who qualify","isRequired":true,"uniqueKey":"showSchedulerToQualified","typeLabel":"boolean"},"qualifyByDefault":{"type":"boolean","description":"Whether respondents qualify unless a rule disqualifies them","isRequired":true,"uniqueKey":"qualifyByDefault","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","description":"When the screener was created (ISO 8601)","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"When the screener was last updated (ISO 8601)","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"questions":{"type":"array","items":{"oneOf":[{"type":"object","description":"A screener question. Template-sourced questions are returned expanded into their concrete category.","required":["isRequired","id","workspaceId","category","type","name"],"properties":{"category":{"type":"string","enum":["simple"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["SHORT_FORM","LONG_FORM","DATE","NUMBER"],"description":"Whether the question collects short text, long text, a date, or a number","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.name","typeLabel":"string"},"isRequired":{"type":"boolean","description":"Whether a response is required before the screener can be submitted","default":true,"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.isRequired","typeLabel":"boolean"},"id":{"type":"string","description":"The question id","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.id","typeLabel":"string"},"workspaceId":{"type":"string","description":"The workspace that owns the question","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.0.workspaceId","typeLabel":"string"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.0.description","typeLabel":"string"},"mappedToPropertyId":{"type":"string","description":"Map the response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.0.mappedToPropertyId","typeLabel":"string"},"questionTemplateId":{"type":"string","description":"Present for questions created from a template","uniqueKey":"questions.items.[INDEX].oneOf.0.questionTemplateId","typeLabel":"string"}},"uniqueKey":"questions.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A screener question. Template-sourced questions are returned expanded into their concrete category.","required":["isRequired","randomizeOrder","includeOther","includeNoneOfTheAbove","id","workspaceId","category","type","name","options"],"properties":{"category":{"type":"string","enum":["option"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["SINGLE_SELECT","MULTI_SELECT"],"description":"Whether respondents may select one option (SINGLE_SELECT) or several (MULTI_SELECT)","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.name","typeLabel":"string"},"isRequired":{"type":"boolean","description":"Whether a response is required before the screener can be submitted","default":true,"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.isRequired","typeLabel":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The display value of the option","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.options.items.[INDEX].value","typeLabel":"string"},"mappedToPropertyOptionId":{"type":"string","description":"The property option this option maps to. Omit to leave the option unmapped when the question has a mappedToPropertyId.","uniqueKey":"questions.items.[INDEX].oneOf.1.options.items.[INDEX].mappedToPropertyOptionId","typeLabel":"string"}},"required":["value"],"description":"An option for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.1.options.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":25,"description":"The selectable options, in display order","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.options","typeLabel":"object[]"},"randomizeOrder":{"type":"boolean","description":"Whether options are shown in a random order per respondent","default":false,"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.randomizeOrder","typeLabel":"boolean"},"includeOther":{"type":"boolean","description":"Whether the question has a free-text \"Other\" option","default":false,"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.includeOther","typeLabel":"boolean"},"includeNoneOfTheAbove":{"type":"boolean","description":"Whether the question has a \"None of the above\" option","default":false,"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.includeNoneOfTheAbove","typeLabel":"boolean"},"id":{"type":"string","description":"The question id","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.id","typeLabel":"string"},"workspaceId":{"type":"string","description":"The workspace that owns the question","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.workspaceId","typeLabel":"string"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.1.description","typeLabel":"string"},"rules":{"type":"array","items":{"type":"object","properties":{"operator":{"type":"string","enum":["IS_EXACTLY","DOESNT_EQUAL","INCLUDES_ANY_OF","INCLUDES_ALL_OF","NOT_INCLUDES_ANY_OF"],"description":"The comparison applied by a screener question rule","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"optionValues":{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].optionValues.items.[INDEX]","typeLabel":"string"},"description":"The option values the operator compares against. Must reference question options, or \"OTHER\"/\"NONE\" when enabled.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].optionValues","typeLabel":"string[]"},"action":{"oneOf":[{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type"],"properties":{"type":{"type":"string","enum":["END_SCREENER"],"description":"End the screener when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].action.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].action.oneOf.0","typeLabel":"object"},{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type","index"],"properties":{"type":{"type":"string","enum":["JUMP"],"description":"Jump to another question when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].action.oneOf.1.type","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","description":"The zero-based index of the question to jump to. Must reference a question after this one; use END_SCREENER to route past the last question.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].action.oneOf.1.index","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].action.oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].action","typeLabel":"object"},"qualificationLogic":{"type":"string","enum":["QUALIFY","DISQUALIFY"],"description":"Omit for jump or end actions that only route the response","uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX].qualificationLogic","typeLabel":"enum\u003cstring>"}},"required":["operator","optionValues"],"additionalProperties":false,"description":"Qualification or skip logic for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.1.rules.items.[INDEX]","typeLabel":"object"},"description":"Qualification or skip logic evaluated against the selected options","uniqueKey":"questions.items.[INDEX].oneOf.1.rules","typeLabel":"object[]"},"mappedToPropertyId":{"type":"string","description":"Map the response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.1.mappedToPropertyId","typeLabel":"string"},"otherDisplayText":{"type":"string","description":"The display text of the free-text \"Other\" option","uniqueKey":"questions.items.[INDEX].oneOf.1.otherDisplayText","typeLabel":"string"},"questionTemplateId":{"type":"string","description":"Present for questions created from a template","uniqueKey":"questions.items.[INDEX].oneOf.1.questionTemplateId","typeLabel":"string"}},"uniqueKey":"questions.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A screener question. Template-sourced questions are returned expanded into their concrete category.","required":["isRequired","id","workspaceId","category","type","name","options"],"properties":{"category":{"type":"string","enum":["dropdown"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["DROPDOWN"],"description":"A dropdown question type","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.name","typeLabel":"string"},"isRequired":{"type":"boolean","description":"Whether a response is required before the screener can be submitted","default":true,"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.isRequired","typeLabel":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The display value of the option","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.options.items.[INDEX].value","typeLabel":"string"},"mappedToPropertyOptionId":{"type":"string","description":"The property option this option maps to. Omit to leave the option unmapped when the question has a mappedToPropertyId.","uniqueKey":"questions.items.[INDEX].oneOf.2.options.items.[INDEX].mappedToPropertyOptionId","typeLabel":"string"}},"required":["value"],"description":"An option for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.2.options.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":25,"description":"The selectable options, in display order","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.options","typeLabel":"object[]"},"id":{"type":"string","description":"The question id","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.id","typeLabel":"string"},"workspaceId":{"type":"string","description":"The workspace that owns the question","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.workspaceId","typeLabel":"string"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.2.description","typeLabel":"string"},"rules":{"type":"array","items":{"type":"object","properties":{"operator":{"type":"string","enum":["IS_EXACTLY","DOESNT_EQUAL","INCLUDES_ANY_OF","INCLUDES_ALL_OF","NOT_INCLUDES_ANY_OF"],"description":"The comparison applied by a screener question rule","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"optionValues":{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].optionValues.items.[INDEX]","typeLabel":"string"},"description":"The option values the operator compares against. Must reference question options, or \"OTHER\"/\"NONE\" when enabled.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].optionValues","typeLabel":"string[]"},"action":{"oneOf":[{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type"],"properties":{"type":{"type":"string","enum":["END_SCREENER"],"description":"End the screener when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.0","typeLabel":"object"},{"type":"object","description":"What happens when a rule matches. Omit to continue to the next question.","required":["type","index"],"properties":{"type":{"type":"string","enum":["JUMP"],"description":"Jump to another question when the rule matches","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.1.type","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","description":"The zero-based index of the question to jump to. Must reference a question after this one; use END_SCREENER to route past the last question.","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.1.index","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action.oneOf.1","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].action","typeLabel":"object"},"qualificationLogic":{"type":"string","enum":["QUALIFY","DISQUALIFY"],"description":"Omit for jump or end actions that only route the response","uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX].qualificationLogic","typeLabel":"enum\u003cstring>"}},"required":["operator","optionValues"],"additionalProperties":false,"description":"Qualification or skip logic for a select or dropdown question","uniqueKey":"questions.items.[INDEX].oneOf.2.rules.items.[INDEX]","typeLabel":"object"},"description":"Qualification or skip logic evaluated against the selected option","uniqueKey":"questions.items.[INDEX].oneOf.2.rules","typeLabel":"object[]"},"mappedToPropertyId":{"type":"string","description":"Map the response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.2.mappedToPropertyId","typeLabel":"string"},"questionTemplateId":{"type":"string","description":"Present for questions created from a template","uniqueKey":"questions.items.[INDEX].oneOf.2.questionTemplateId","typeLabel":"string"}},"uniqueKey":"questions.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A screener question. Template-sourced questions are returned expanded into their concrete category.","required":["isRequired","id","workspaceId","category","type","name","rows","columns"],"properties":{"category":{"type":"string","enum":["matrix"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.category","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["MATRIX"],"description":"A matrix question type","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The question prompt","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.name","typeLabel":"string"},"isRequired":{"type":"boolean","description":"Whether a response is required before the screener can be submitted","default":true,"isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.isRequired","typeLabel":"boolean"},"rows":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","maxLength":100,"description":"The row label","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.rows.items.[INDEX].value","typeLabel":"string"},"mappedToPropertyId":{"type":"string","description":"Map this row's response to a person property","uniqueKey":"questions.items.[INDEX].oneOf.3.rows.items.[INDEX].mappedToPropertyId","typeLabel":"string"},"columnToPropertyOptionId":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"questions.items.[INDEX].oneOf.3.rows.items.[INDEX].columnToPropertyOptionId.additionalProperties","typeLabel":"string"},"description":"Maps a column value to a property option id. Columns missing from this map are left unmapped.","uniqueKey":"questions.items.[INDEX].oneOf.3.rows.items.[INDEX].columnToPropertyOptionId","typeLabel":"object"}},"required":["value"],"description":"A row of a matrix question","uniqueKey":"questions.items.[INDEX].oneOf.3.rows.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":25,"description":"The matrix rows","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.rows","typeLabel":"object[]"},"columns":{"type":"array","items":{"type":"string","maxLength":40,"uniqueKey":"questions.items.[INDEX].oneOf.3.columns.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":25,"description":"The shared column labels applied to every row","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.columns","typeLabel":"string[]"},"id":{"type":"string","description":"The question id","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.id","typeLabel":"string"},"workspaceId":{"type":"string","description":"The workspace that owns the question","isRequired":true,"uniqueKey":"questions.items.[INDEX].oneOf.3.workspaceId","typeLabel":"string"},"description":{"type":"string","description":"Optional helper text shown beneath the question prompt","uniqueKey":"questions.items.[INDEX].oneOf.3.description","typeLabel":"string"},"questionTemplateId":{"type":"string","description":"Present for questions created from a template","uniqueKey":"questions.items.[INDEX].oneOf.3.questionTemplateId","typeLabel":"string"}},"uniqueKey":"questions.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"description":"The screener questions, in display order","isRequired":true,"uniqueKey":"questions","typeLabel":"object[]"},"externalSurveyId":{"type":"string","description":"The id of the linked external survey, when the screener uses one","uniqueKey":"externalSurveyId","typeLabel":"string"},"surveyMonkeyCollectorId":{"type":"string","description":"The SurveyMonkey collector id, when the screener uses a SurveyMonkey survey","uniqueKey":"surveyMonkeyCollectorId","typeLabel":"string"},"externalSurveySetupStatus":{"type":"string","enum":["IN_PROGRESS","READY","FAILED"],"description":"Setup status of an external survey screener","uniqueKey":"externalSurveySetupStatus","typeLabel":"enum\u003cstring>"},"externalSurveySetupErrorCode":{"type":"string","description":"An error code describing why external survey setup failed, when applicable","uniqueKey":"externalSurveySetupErrorCode","typeLabel":"string"},"externalSurveySetupUpdatedAt":{"type":"string","format":"date-time","description":"When the external survey setup status last changed (ISO 8601)","uniqueKey":"externalSurveySetupUpdatedAt","typeLabel":"string\u003cdate-time>"},"customLinkUrl":{"type":"string","description":"The custom link respondents use to take an externally hosted screener","uniqueKey":"customLinkUrl","typeLabel":"string"},"customLinkTokensJson":{"type":"string","description":"JSON describing the query parameters appended to the custom link","uniqueKey":"customLinkTokensJson","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","workspaceId":"\u003cstring>","studyId":"\u003cstring>","type":"RALLY","showSchedulerToQualified":true,"qualifyByDefault":true,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","questions":[{"category":"simple","type":"SHORT_FORM","name":"\u003cstring>","isRequired":true,"id":"\u003cstring>","workspaceId":"\u003cstring>","description":"\u003cstring>","mappedToPropertyId":"\u003cstring>","questionTemplateId":"\u003cstring>"}],"externalSurveyId":"\u003cstring>","surveyMonkeyCollectorId":"\u003cstring>","externalSurveySetupStatus":"IN_PROGRESS","externalSurveySetupErrorCode":"\u003cstring>","externalSurveySetupUpdatedAt":"2023-11-07T05:31:56Z","customLinkUrl":"\u003cstring>","customLinkTokensJson":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7ef63d1c-1cfb-4368-a948-d5a60dd9c3ae":{"description":"Bad Request — JSON with field details for schema validation errors, plain text for domain rule violations","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"errors.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"errors.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"errors.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"(string | number)[]"}},"required":["message","path"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"description":"Error response for a bad request with details on what was invalid","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"message":"\u003cstring>","path":["\u003cstring>"]}]}}},"exampleType":"generated"},"text/plain":{"schema":{"type":"string","example":"Bad Request","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Bad Request"}},"exampleType":"generated"}},"exampleType":"generated"},"40b5d56a-513d-4098-96f4-d65498ad4f9d":{"description":"Unauthorized","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests the client is allowed to make.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining for the client in the current time window.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Reset":{"description":"The time at which the current time window ends (in Unix timestamp format).","schema":{"type":"integer","format":"int32"}}},"content":{"text/plain":{"schema":{"type":"string","example":"Unauthorized","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Unauthorized"}},"exampleType":"generated"}},"exampleType":"generated"},"4dfbc330-ae94-4b50-9ac6-3b8f1dd956b4":{"description":"Forbidden","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests the client is allowed to make.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining for the client in the current time window.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Reset":{"description":"The time at which the current time window ends (in Unix timestamp format).","schema":{"type":"integer","format":"int32"}}},"content":{"text/plain":{"schema":{"type":"string","example":"Forbidden","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Forbidden"}},"exampleType":"generated"}},"exampleType":"generated"},"cf59c06b-4099-48db-acf1-c09a2b637baf":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"string","example":"{Resource} not found","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"{Resource} not found"}},"exampleType":"generated"}},"exampleType":"generated"},"98357505-2042-40dd-aafd-71889d3f64ce":{"description":"Conflict","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests the client is allowed to make.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining for the client in the current time window.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Reset":{"description":"The time at which the current time window ends (in Unix timestamp format).","schema":{"type":"integer","format":"int32"}}},"content":{"text/plain":{"schema":{"type":"string","example":"Study is not in draft status","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Study is not in draft status"}},"exampleType":"generated"}},"exampleType":"generated"},"02066e74-251f-4f39-9378-62dbad6223bb":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"The number of seconds until the client should retry the request.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Limit":{"description":"The maximum number of requests the client is allowed to make.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining for the client in the current time window.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Reset":{"description":"The time at which the current time window ends (in Unix timestamp format).","schema":{"type":"integer","format":"int32"}}},"content":{"text/plain":{"schema":{"type":"string","example":"Too Many Requests","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Too Many Requests"}},"exampleType":"generated"}},"exampleType":"generated"},"c1812238-8b13-4f7c-bf0d-257cd23509d1":{"description":"Internal Server Error","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests the client is allowed to make.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining for the client in the current time window.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Reset":{"description":"The time at which the current time window ends (in Unix timestamp format).","schema":{"type":"integer","format":"int32"}}},"content":{"text/plain":{"schema":{"type":"string","example":"Internal Server Error","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Internal Server Error"}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cde1283d-a729-4424-acbd-c478ba1b3a2e":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"f76dc156-13d8-4704-8eee-b1a1f1f478c2":{"url":"https://api.rallyuxr.com/api/public/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.rallyuxr.com/api/openapi"},"subdomain":"rallyuxr-21","siteName":"Rally Developer Docs","title":"Replace a study's screener - Rally Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-20T15:04:40.963Z","originalFileLocation":"api-reference/screener/replace-a-studys-screener.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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\u0026#x27;s includeScreener flag) when the study has none. Only Rally screeners can be managed via the API. Not available for survey studies.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rally Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Replace a study\u0026#x27;s screener - Rally Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"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\u0026#x27;s includeScreener flag) when the study has none. Only Rally screeners can be managed via the API. Not available for survey studies.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rally Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rallyuxr-21.mintlify.app/_mintlify/api/og/v2?division=Screener\u0026amp;title=Replace+a+study%27s+screener\u0026amp;description=Completely+replace+%28upsert%29+the+screener+for+a+draft+study.+The+entire+screener+configuration+must+be+sent%3A+question+ids+are+regenerated+on+every+call+and+omitt\u0026amp;theme=623a240571fe7758758aabdc\u0026amp;signature=affb2b10f7e02e0a1e2ae4a929855cec5a0ba325d9aaf7d17fa2ae44c7ab169a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Replace a study\u0026#x27;s screener - Rally Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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\u0026#x27;s includeScreener flag) when the study has none. Only Rally screeners can be managed via the API. Not available for survey studies.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rallyuxr-21.mintlify.app/_mintlify/api/og/v2?division=Screener\u0026amp;title=Replace+a+study%27s+screener\u0026amp;description=Completely+replace+%28upsert%29+the+screener+for+a+draft+study.+The+entire+screener+configuration+must+be+sent%3A+question+ids+are+regenerated+on+every+call+and+omitt\u0026amp;theme=623a240571fe7758758aabdc\u0026amp;signature=affb2b10f7e02e0a1e2ae4a929855cec5a0ba325d9aaf7d17fa2ae44c7ab169a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/rallyuxr-21/OX7572CSGIzrFHPB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rally Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#101014\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/screener/replace-a-studys-screener.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.rallyuxr.com/#organization\",\"name\":\"Rally Developer Docs\",\"url\":\"https://docs.rallyuxr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rallyuxr-21/xXqJ3k5MbwVd7Nk6/logo/light.svg?fit=max\u0026auto=format\u0026n=xXqJ3k5MbwVd7Nk6\u0026q=85\u0026s=c3a14e4fbdb0423495b2ccff80c58308\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.rallyuxr.com#website\",\"name\":\"Rally Developer Docs\",\"url\":\"https://docs.rallyuxr.com\",\"publisher\":{\"@id\":\"https://docs.rallyuxr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener#webpage\",\"url\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener\",\"name\":\"Replace a study's screener\",\"description\":\"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.\",\"dateModified\":\"2026-08-20T15:04:40.963Z\",\"isPartOf\":{\"@id\":\"https://docs.rallyuxr.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Screener\",\"item\":\"https://docs.rallyuxr.com/api-reference/screener/get-a-studys-screener\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Replace a study's screener\",\"item\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener#apireference\",\"headline\":\"Replace a study's screener\",\"name\":\"Replace a study's screener\",\"description\":\"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.\",\"url\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rallyuxr.com/api-reference/screener/replace-a-studys-screener#webpage\"},\"dateModified\":\"2026-08-20T15:04:40.963Z\",\"publisher\":{\"@id\":\"https://docs.rallyuxr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.rallyuxr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rally Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rally Developer Docs","nav":{"global":{"anchors":[{"anchor":"Help Center","href":"https://help.rallyuxr.com/en/","icon":"book-open-cover"},{"anchor":"Blog","href":"https://www.rallyuxr.com/blog","icon":"newspaper"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Backfills","pages":[{"title":"Import activities","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /activities/import","href":"/api-reference/backfills/import-activities"}]},{"group":"Person","pages":[{"title":"Returns a person in your workspace","deprecated":true,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /person","href":"/api-reference/person/returns-a-person-in-your-workspace"},{"title":"Updates a person's opted out status","deprecated":true,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /person","href":"/api-reference/person/updates-a-persons-opted-out-status"},{"title":"Deletes people by email","deprecated":true,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /person/delete","href":"/api-reference/person/deletes-people-by-email"}]},{"group":"Messages","pages":[{"title":"Search for emails","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /messages/emails/search","href":"/api-reference/messages/search-for-emails"}]},{"group":"Forms","pages":[{"title":"Search submissions for a consent form","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /consent/{consentFormId}/submissions/search","href":"/api-reference/forms/search-submissions-for-a-consent-form"},{"title":"Search submissions for a signup form","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /signups/{signupFormId}/submissions/search","href":"/api-reference/forms/search-submissions-for-a-signup-form"}]},{"group":"Imports","pages":[{"title":"Gets an import by id","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /imports/{importId}","href":"/api-reference/imports/gets-an-import-by-id"}]},{"group":"Incentives","pages":[{"title":"Get paginated list of incentives","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /incentives/search","href":"/api-reference/incentives/get-paginated-list-of-incentives"},{"title":"List incentive IDs","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /incentives","href":"/api-reference/incentives/list-incentive-ids"},{"title":"Send an incentive to study participants","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /incentives","href":"/api-reference/incentives/send-an-incentive-to-study-participants"},{"title":"Resend an incentive","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /incentives/{incentiveId}/resend","href":"/api-reference/incentives/resend-an-incentive"},{"title":"Cancel an incentive","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /incentives/{incentiveId}/cancel","href":"/api-reference/incentives/cancel-an-incentive"},{"title":"Log a custom incentive for study participants","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /incentives/custom/log","href":"/api-reference/incentives/log-a-custom-incentive-for-study-participants"},{"title":"Get paginated list of custom incentives","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /incentives/custom","href":"/api-reference/incentives/get-paginated-list-of-custom-incentives"},{"title":"Get a custom incentive by id","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /incentives/custom/{customIncentiveId}","href":"/api-reference/incentives/get-a-custom-incentive-by-id"},{"title":"Get an incentive by id","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /incentives/{incentiveId}","href":"/api-reference/incentives/get-an-incentive-by-id"}]},{"group":"Participant Status Events","pages":[{"title":"Get a paginated list of participant status-change events.","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /participant-status-events/search","href":"/api-reference/participant-status-events/get-a-paginated-list-of-participant-status-change-events"}]},{"group":"AI","pages":[{"title":"AI search for people","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /ai/people/search","href":"/api-reference/ai/ai-search-for-people"}]},{"group":"People","pages":[{"title":"Search for people","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /people/search","href":"/api-reference/people/search-for-people"},{"title":"Import people","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /people/import","href":"/api-reference/people/import-people"},{"title":"Delete people","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /people/delete","href":"/api-reference/people/delete-people"},{"title":"Delete a person","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi delete /people/{personId}","href":"/api-reference/people/delete-a-person"},{"title":"Get a person's opted out status by ID or email","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /people/{personIdOrEmail}/opted-out","href":"/api-reference/people/get-a-persons-opted-out-status-by-id-or-email"},{"title":"Update a person's opted out status","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi put /people/{personIdOrEmail}/opted-out","href":"/api-reference/people/update-a-persons-opted-out-status"}]},{"group":"Populations","pages":[{"title":"Paginated list of population in your workspace","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /populations","href":"/api-reference/populations/paginated-list-of-population-in-your-workspace"}]},{"group":"Person Properties","pages":[{"title":"Search properties by name or value","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /properties/search","href":"/api-reference/person-properties/search-properties-by-name-or-value"},{"title":"Create multiple new person properties","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /properties/import","href":"/api-reference/person-properties/create-multiple-new-person-properties"},{"title":"Get all person properties in your workspace","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /properties","href":"/api-reference/person-properties/get-all-person-properties-in-your-workspace"},{"title":"Delete person properties in bulk","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /properties/delete","href":"/api-reference/person-properties/delete-person-properties-in-bulk"},{"title":"Get a person property by ID","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /properties/{propertyId}","href":"/api-reference/person-properties/get-a-person-property-by-id"},{"title":"Update a person property by ID","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi put /properties/{propertyId}","href":"/api-reference/person-properties/update-a-person-property-by-id"},{"title":"Deletes a person property by ID","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi delete /properties/{propertyId}","href":"/api-reference/person-properties/deletes-a-person-property-by-id"},{"title":"Get all person property groups in your workspace","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /property-groups","href":"/api-reference/person-properties/get-all-person-property-groups-in-your-workspace"},{"title":"Get a person property group by ID","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /property-groups/{propertyGroupId}","href":"/api-reference/person-properties/get-a-person-property-group-by-id"},{"title":"Get the properties in a person property group","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /property-groups/{propertyGroupId}/properties","href":"/api-reference/person-properties/get-the-properties-in-a-person-property-group"}]},{"group":"Segments","pages":[{"title":"Paginated list of segments in your workspace","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /segments/search","href":"/api-reference/segments/paginated-list-of-segments-in-your-workspace"}]},{"group":"Studies","pages":[{"title":"Create a new study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies","href":"/api-reference/studies/create-a-new-study"},{"title":"Get paginated list of studies in your workspace.","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/search","href":"/api-reference/studies/get-paginated-list-of-studies-in-your-workspace"},{"title":"Get a study by ID","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}","href":"/api-reference/studies/get-a-study-by-id"},{"title":"Update a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi put /studies/{studyId}","href":"/api-reference/studies/update-a-study"},{"title":"Update a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi patch /studies/{studyId}","href":"/api-reference/studies/update-a-study-1"},{"title":"Update a study status","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/status","href":"/api-reference/studies/update-a-study-status"},{"title":"Search screener/survey responses for a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/responses/search","href":"/api-reference/studies/search-screenersurvey-responses-for-a-study"},{"title":"Get a paginated list of study templates","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/templates","href":"/api-reference/studies/get-a-paginated-list-of-study-templates"},{"title":"Get a paginated list of interviews in a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/interviews","href":"/api-reference/studies/get-a-paginated-list-of-interviews-in-a-study"},{"title":"Get an interview by ID","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/interviews/{interviewBookingId}","href":"/api-reference/studies/get-an-interview-by-id"},{"title":"Get the observer room for an interview","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/interviews/{interviewBookingId}/observer-room","href":"/api-reference/studies/get-the-observer-room-for-an-interview"},{"title":"Get the observer rooms for a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/observer-rooms","href":"/api-reference/studies/get-the-observer-rooms-for-a-study"},{"title":"Get the transcript for an observer room bot","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/observer-rooms/{observerRoomId}/transcripts/{botId}","href":"/api-reference/studies/get-the-transcript-for-an-observer-room-bot"},{"title":"Publish a draft study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/publish","href":"/api-reference/studies/publish-a-draft-study"}]},{"group":"Participants","pages":[{"title":"Paginated list of participants in a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/participants/search","href":"/api-reference/participants/paginated-list-of-participants-in-a-study"},{"title":"Count participants in a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/participants/count","href":"/api-reference/participants/count-participants-in-a-study"},{"title":"Import participants to a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/participants/import","href":"/api-reference/participants/import-participants-to-a-study"},{"title":"Get a participant by ID","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/participants/{participantId}","href":"/api-reference/participants/get-a-participant-by-id"},{"title":"Append a note to a participant","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi patch /studies/{studyId}/participants/{participantId}/notes","href":"/api-reference/participants/append-a-note-to-a-participant"}]},{"group":"Screener","pages":[{"title":"Get a study's screener","description":"Fetch the full screener (top-level properties and all questions) for a study. Only available while the study is in draft status; any other status responds with 409. Not available for survey studies.","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/screener","href":"/api-reference/screener/get-a-studys-screener"},{"title":"Replace a study's screener","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi put /studies/{studyId}/screener","href":"/api-reference/screener/replace-a-studys-screener"},{"title":"Delete a study's screener","description":"Delete the screener (and all of its questions) from a draft study and set the study's includeScreener flag to false. Only Rally screeners can be deleted via the API. Not available for survey studies.","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi delete /studies/{studyId}/screener","href":"/api-reference/screener/delete-a-studys-screener"},{"title":"Update a screener's top-level properties","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi patch /studies/{studyId}/screener","href":"/api-reference/screener/update-a-screeners-top-level-properties"},{"title":"Create a screener question","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/screener/questions","href":"/api-reference/screener/create-a-screener-question"},{"title":"Get a screener question","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/screener/questions/{questionId}","href":"/api-reference/screener/get-a-screener-question"},{"title":"Update a screener question","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi put /studies/{studyId}/screener/questions/{questionId}","href":"/api-reference/screener/update-a-screener-question"},{"title":"Delete a screener question","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi delete /studies/{studyId}/screener/questions/{questionId}","href":"/api-reference/screener/delete-a-screener-question"}]},{"group":"Consent Submissions","pages":[{"title":"Export consent submissions for a study","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/consent-submissions/export","href":"/api-reference/consent-submissions/export-consent-submissions-for-a-study"},{"title":"Get consent submission export status","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /studies/{studyId}/consent-submissions/export/{exportId}","href":"/api-reference/consent-submissions/get-consent-submission-export-status"},{"title":"Export consent submission for a person","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /people/{personId}/consent-submissions/export","href":"/api-reference/consent-submissions/export-consent-submission-for-a-person"}]},{"group":"Study Status Events","pages":[{"title":"Poll study status-change events in your workspace","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /study-status-events/search","href":"/api-reference/study-status-events/poll-study-status-change-events-in-your-workspace"}]},{"group":"Users","pages":[{"title":"Get the current authenticated user","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /me","href":"/api-reference/users/get-the-current-authenticated-user"},{"title":"Gets a paginated list of all users","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /users","href":"/api-reference/users/gets-a-paginated-list-of-all-users"}]},{"group":"Teams","pages":[{"title":"Paginated list of teams in your workspace","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi get /teams","href":"/api-reference/teams/paginated-list-of-teams-in-your-workspace"}]},{"group":"API Reference","pages":[{"title":"Personopted out","version":null,"deprecated":null,"openapi":"https://api.rallyuxr.com/api/openapi webhook person.opted_out","href":"/api-reference/personopted_out"},{"title":"Person importapifinished","version":null,"deprecated":null,"openapi":"https://api.rallyuxr.com/api/openapi webhook person_import.api.finished","href":"/api-reference/person_importapifinished"},{"title":"Person importcsvfinished","version":null,"deprecated":null,"openapi":"https://api.rallyuxr.com/api/openapi webhook person_import.csv.finished","href":"/api-reference/person_importcsvfinished"},{"title":"Participantstatus changed","version":null,"deprecated":null,"openapi":"https://api.rallyuxr.com/api/openapi webhook participant.status_changed","href":"/api-reference/participantstatus_changed"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/person-opt-out"}]}]},"title":"Replace a study's screener - Rally Developer Docs","buildId":"dpl_7EGD3AHhNmnVNgQ8U7beMHiqTzw8","deploymentId":"dpl_7EGD3AHhNmnVNgQ8U7beMHiqTzw8","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BD4fwK3P.js","utils-DEvhfoIn.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-Bbxkx6RX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CXCpkzYi.js","snippetPresets-C1KobSGD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CbXPTquJ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CDxejPjz.js","shallow-CKF2GM14.js","getApiPlaygroundDisplay-irpiNmfQ.js","CodeSnippet-CMmU-qdX.js","CodeSnippets-X0z6bNcm.js","Page-DzZeX12I.js","getPastedJson-owIG6uLE.js","icon-CJ0Id64A.js","MethodPill-CTSdHD-F.js","DuplicateIcon-OhvNP1l6.js","createIcon-Dn3UVmnj.js","DynamicMarkdown-D0HL0Gbr.js","SectionHeading-Cr9OIW6W.js","axios-vUo_bRtp.js","Markdown-B5KRcbdD.js","clsx-sjO-6dpI.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmpPxlnF.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-OSEgb-y8.js"]}