{"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.3990","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":{},"basePath":"","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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/studies/update-a-study-status","slug":"/api-reference/studies/update-a-study-status","pageMetadata":{"title":"Update a study status","description":"Update the status of a study in your workspace. This is the only way to programatically change a study's status","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/status","href":"/api-reference/studies/update-a-study-status","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: \"Update the status of a study in your workspace. This is the only way to programatically change a study’s status\"\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":"Update a study status","description":"Update the status of a study in your workspace. This is the only way to programatically change a study's status","deprecated":null,"version":null,"openapi":"https://api.rallyuxr.com/api/openapi post /studies/{studyId}/status","href":"/api-reference/studies/update-a-study-status","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Studies"],"summary":"Update a study status","description":"Update the status of a study in your workspace. This is the only way to programatically change a study's status","security":["a4593bc1-96cd-4578-89bd-14e8588226c5"],"parameters":["e0f88291-3211-43f9-a0a0-0637592ba3b9"],"requestBody":"969be8fe-9eac-424b-85d2-9c9a69b5152a","responses":{"200":"98353779-b557-42e4-8e53-00edc61097a5","400":"adb0b129-70ce-4cd5-b1d7-6df8a3ce8816","401":"e1d9f6f2-8bd1-4186-a070-ab42d0bc3f56","403":"c3de9074-f413-4d6d-b607-a02531f33ac1","404":"9cb43f8d-c54d-4d61-96d3-ff9b770738cf","429":"8a95f6f6-0f2b-495e-85d9-997dedb787de","500":"5a87bdbb-caab-4d2b-8626-4f9b68a35b1e"},"method":"post","type":"path","servers":["f76dc156-13d8-4704-8eee-b1a1f1f478c2"],"path":"/studies/{studyId}/status","baseUrlOptions":["https://api.rallyuxr.com/api/public/v1"],"title":"Update a study status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e0f88291-3211-43f9-a0a0-0637592ba3b9":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"studyId","in":"path"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["PAUSED","CLOSED"],"description":"Statuses a study can be updated to via the API","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"required":["status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"98353779-b557-42e4-8e53-00edc61097a5":{"description":"The updated study","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","properties":{"studyId":{"type":"string","isRequired":true,"uniqueKey":"studyId","typeLabel":"string"},"studyType":{"type":"string","enum":["SURVEY","INTERVIEWS","UNMODERATED_TEST","GROUP_INTERVIEW"],"description":"The type of study","isRequired":true,"uniqueKey":"studyType","typeLabel":"enum\u003cstring>"},"recruitmentStrategy":{"type":"string","description":"The recruitment strategy for the study","enum":["IN_RALLY","EXTERNAL"],"isRequired":true,"uniqueKey":"recruitmentStrategy","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["DRAFT","ACTIVE","PAUSED","CLOSED"],"description":"The status of the study","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"studyPlan":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The internal name of the study","isRequired":true,"uniqueKey":"studyPlan.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The internal name of the study","isRequired":true,"uniqueKey":"studyPlan.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.name","typeLabel":"string | null"},"externalName":{"oneOf":[{"type":"string","description":"The external name of the study","isRequired":true,"uniqueKey":"studyPlan.externalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The external name of the study","isRequired":true,"uniqueKey":"studyPlan.externalName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.externalName","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"The internal description of the study","isRequired":true,"uniqueKey":"studyPlan.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The internal description of the study","isRequired":true,"uniqueKey":"studyPlan.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.description","typeLabel":"string | null"},"externalDescription":{"oneOf":[{"type":"string","description":"The external description of the study","isRequired":true,"uniqueKey":"studyPlan.externalDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"The external description of the study","isRequired":true,"uniqueKey":"studyPlan.externalDescription.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.externalDescription","typeLabel":"string | null"},"startDate":{"oneOf":[{"type":"string","description":"The start date of the study in YYYY-MM-DD format","format":"date","example":"2025-01-01","isRequired":true,"uniqueKey":"studyPlan.startDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"The start date of the study in ISO 8601 in UTC(with no offset). The time is truncated","format":"date-time","deprecated":true,"example":"2025-01-01T00:00:00Z","isRequired":true,"uniqueKey":"studyPlan.startDate.oneOf.1","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"studyPlan.startDate.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.startDate","typeLabel":"string\u003cdate> | string\u003cdate-time> | null"},"endDate":{"oneOf":[{"type":"string","description":"The end date of the study in YYYY-MM-DD format","format":"date","example":"2025-01-02","isRequired":true,"uniqueKey":"studyPlan.endDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"The end date of the study in ISO 8601 in UTC(with no offset). The time is truncated","format":"date-time","deprecated":true,"example":"2025-01-02T00:00:00Z","isRequired":true,"uniqueKey":"studyPlan.endDate.oneOf.1","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"studyPlan.endDate.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.endDate","typeLabel":"string\u003cdate> | string\u003cdate-time> | null"},"researchPlanUrl":{"oneOf":[{"type":"string","description":"The URL of the research plan","isRequired":true,"uniqueKey":"studyPlan.researchPlanUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL of the research plan","isRequired":true,"uniqueKey":"studyPlan.researchPlanUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.researchPlanUrl","typeLabel":"string | null"},"participationLimit":{"oneOf":[{"type":"number","default":10,"description":"The participation limit of the study","isRequired":true,"uniqueKey":"studyPlan.participationLimit.oneOf.0","typeLabel":"number"},{"type":"null","default":10,"description":"The participation limit of the study","isRequired":true,"uniqueKey":"studyPlan.participationLimit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.participationLimit","typeLabel":"number | null"},"consentFormId":{"oneOf":[{"type":"string","description":"The ID of the consent form","isRequired":true,"uniqueKey":"studyPlan.consentFormId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the consent form","isRequired":true,"uniqueKey":"studyPlan.consentFormId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.consentFormId","typeLabel":"string | null"},"incentive":{"oneOf":[{"type":"object","properties":{"incentiveType":{"type":"string","enum":["MONEY_OR_GIFT_CARD","MONEY_OR_GIFT_CARD_WITH_TREMENDOUS","EXTERNAL_MONEY_OR_GIFT_CARD","CHARITY","CUSTOM","RESPONDENT_MONEY","RECRUITMENT_FEE"],"description":"The type of incentive","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.incentiveType","typeLabel":"enum\u003cstring>"},"incentiveBudgetId":{"oneOf":[{"type":"string","description":"The ID of the incentive budget","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.incentiveBudgetId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the incentive budget","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.incentiveBudgetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.incentiveBudgetId","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"number","description":"The amount of the incentive","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The amount of the incentive","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.amount","typeLabel":"number | null"},"customIncentiveId":{"oneOf":[{"type":"string","description":"If type is CUSTOM then the ID of the custom incentive","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.customIncentiveId.oneOf.0","typeLabel":"string"},{"type":"null","description":"If type is CUSTOM then the ID of the custom incentive","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.customIncentiveId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.customIncentiveId","typeLabel":"string | null"},"defaultCustomIncentiveValue":{"oneOf":[{"type":"string","description":"If type is CUSTOM then the default value of the custom incentive","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.defaultCustomIncentiveValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"If type is CUSTOM then the default value of the custom incentive","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.defaultCustomIncentiveValue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0.defaultCustomIncentiveValue","typeLabel":"string | null"},"currency":{"type":"string","description":"The currency of the incentive","enum":["USD","EUR","GBP","CAD","AUD","NZD"],"uniqueKey":"studyPlan.incentive.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"required":["incentiveType","incentiveBudgetId","amount","customIncentiveId","defaultCustomIncentiveValue"],"description":"The incentive details for the study","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"incentiveType":{"type":"string","enum":["MONEY_OR_GIFT_CARD","MONEY_OR_GIFT_CARD_WITH_TREMENDOUS","EXTERNAL_MONEY_OR_GIFT_CARD","CHARITY","CUSTOM","RESPONDENT_MONEY","RECRUITMENT_FEE"],"description":"The type of incentive"},"incentiveBudgetId":{"oneOf":[{"type":"string","description":"The ID of the incentive budget"},{"type":"null","description":"The ID of the incentive budget"}]},"amount":{"oneOf":[{"type":"number","description":"The amount of the incentive"},{"type":"null","description":"The amount of the incentive"}]},"currency":{"type":"string","description":"The currency of the incentive","enum":["USD","EUR","GBP","CAD","AUD","NZD"]},"customIncentiveId":{"oneOf":[{"type":"string","description":"If type is CUSTOM then the ID of the custom incentive"},{"type":"null","description":"If type is CUSTOM then the ID of the custom incentive"}]},"defaultCustomIncentiveValue":{"oneOf":[{"type":"string","description":"If type is CUSTOM then the default value of the custom incentive"},{"type":"null","description":"If type is CUSTOM then the default value of the custom incentive"}]}},"required":["incentiveType","incentiveBudgetId","amount","customIncentiveId","defaultCustomIncentiveValue"],"description":"The incentive details for the study","isRequired":true,"uniqueKey":"studyPlan.incentive.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.incentive","typeLabel":"object | null"},"includeScreener":{"type":"boolean","description":"Whether to include a screener. If type is `SURVEY` the default is true, if not then false","isRequired":true,"uniqueKey":"studyPlan.includeScreener","typeLabel":"boolean"},"brandingConfigId":{"oneOf":[{"type":"string","description":"The ID of the branding configuration. Setting it mirrors changing the branding in-app: it also updates the study landing page's button color and, when the branding config has a workspace email, the study's booking-confirmation, booking-cancellation, interview-reminder, and interview-reschedule email defaults. On update, pass null to clear the study's branding.","isRequired":true,"uniqueKey":"studyPlan.brandingConfigId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the branding configuration. Setting it mirrors changing the branding in-app: it also updates the study landing page's button color and, when the branding config has a workspace email, the study's booking-confirmation, booking-cancellation, interview-reminder, and interview-reschedule email defaults. On update, pass null to clear the study's branding.","isRequired":true,"uniqueKey":"studyPlan.brandingConfigId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"studyPlan.brandingConfigId","typeLabel":"string | null"},"language":{"type":"string","enum":["en","es","fr","it","ro","pt","pl","de","nl","ja","pt_BR","ko","cs","hi","sk","ar","tr"],"default":"en","description":"The language code for the study","isRequired":true,"uniqueKey":"studyPlan.language","typeLabel":"enum\u003cstring>"},"scheduler":{"oneOf":[{"type":"object","properties":{"interviewDurationMinutes":{"type":"integer","description":"The planned interview duration in minutes.","example":60,"isRequired":true,"uniqueKey":"studyPlan.scheduler.oneOf.0.interviewDurationMinutes","typeLabel":"integer"}},"required":["interviewDurationMinutes"],"description":"Scheduler configuration for the study. Read-only. Populated only when `studyType` is `INTERVIEWS` and the study has a configured scheduler; otherwise the parent `scheduler` field is null (i.e. for `SURVEY`, `UNMODERATED_TEST`, `GROUP_INTERVIEW`, or `INTERVIEWS` studies without a scheduler row).","uniqueKey":"studyPlan.scheduler.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"interviewDurationMinutes":{"type":"integer","description":"The planned interview duration in minutes.","example":60}},"required":["interviewDurationMinutes"],"description":"Scheduler configuration for the study. Read-only. Populated only when `studyType` is `INTERVIEWS` and the study has a configured scheduler; otherwise the parent `scheduler` field is null (i.e. for `SURVEY`, `UNMODERATED_TEST`, `GROUP_INTERVIEW`, or `INTERVIEWS` studies without a scheduler row).","uniqueKey":"studyPlan.scheduler.oneOf.1","typeLabel":"null"}],"uniqueKey":"studyPlan.scheduler","typeLabel":"object | null"}},"required":["name","externalName","description","externalDescription","startDate","endDate","researchPlanUrl","participationLimit","consentFormId","incentive","includeScreener","brandingConfigId","language"],"description":"Study plan object","isRequired":true,"uniqueKey":"studyPlan","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"createdFromTemplateId":{"oneOf":[{"type":"string","description":"The ID of the template this study was created from, or null if not created from a template","isRequired":true,"uniqueKey":"createdFromTemplateId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the template this study was created from, or null if not created from a template","isRequired":true,"uniqueKey":"createdFromTemplateId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdFromTemplateId","typeLabel":"string | null"},"owners":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","isRequired":true,"uniqueKey":"owners.items.[INDEX].userId","typeLabel":"string"},"emailAccountId":{"type":"string","isRequired":true,"uniqueKey":"owners.items.[INDEX].emailAccountId","typeLabel":"string"},"fullname":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"owners.items.[INDEX].fullname.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"owners.items.[INDEX].fullname.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"owners.items.[INDEX].fullname","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"owners.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"owners.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"owners.items.[INDEX].email","typeLabel":"string | null"}},"required":["userId","emailAccountId","fullname","email"],"description":"Study owner object","uniqueKey":"owners.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"owners","typeLabel":"object[]"}},"required":["studyId","studyType","recruitmentStrategy","status","studyPlan","createdAt","createdFromTemplateId","owners"],"description":"Study object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"studyId":"\u003cstring>","studyType":"SURVEY","recruitmentStrategy":"IN_RALLY","status":"DRAFT","studyPlan":{"name":"\u003cstring>","externalName":"\u003cstring>","description":"\u003cstring>","externalDescription":"\u003cstring>","startDate":"2025-01-01","endDate":"2025-01-02","researchPlanUrl":"\u003cstring>","participationLimit":10,"consentFormId":"\u003cstring>","incentive":{"incentiveType":"MONEY_OR_GIFT_CARD","incentiveBudgetId":"\u003cstring>","amount":123,"customIncentiveId":"\u003cstring>","defaultCustomIncentiveValue":"\u003cstring>","currency":"USD"},"includeScreener":true,"brandingConfigId":"\u003cstring>","language":"en","scheduler":{"interviewDurationMinutes":60}},"createdAt":"2023-11-07T05:31:56Z","createdFromTemplateId":"\u003cstring>","owners":[{"userId":"\u003cstring>","emailAccountId":"\u003cstring>","fullname":"\u003cstring>","email":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"adb0b129-70ce-4cd5-b1d7-6df8a3ce8816":{"description":"Bad Request","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"}},"exampleType":"generated"},"e1d9f6f2-8bd1-4186-a070-ab42d0bc3f56":{"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"},"c3de9074-f413-4d6d-b607-a02531f33ac1":{"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"},"9cb43f8d-c54d-4d61-96d3-ff9b770738cf":{"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"},"8a95f6f6-0f2b-495e-85d9-997dedb787de":{"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"},"5a87bdbb-caab-4d2b-8626-4f9b68a35b1e":{"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":{"a4593bc1-96cd-4578-89bd-14e8588226c5":{"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":"Update a study status - Rally Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-20T15:04:40.861Z","originalFileLocation":"api-reference/studies/update-a-study-status.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=\"Update the status of a study in your workspace. This is the only way to programatically change a study\u0026#x27;s status\">\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=\"Update a study status - Rally Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update the status of a study in your workspace. This is the only way to programatically change a study\u0026#x27;s status\">\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/studies/update-a-study-status\">\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=Studies\u0026amp;title=Update+a+study+status\u0026amp;description=Update+the+status+of+a+study+in+your+workspace.+This+is+the+only+way+to+programatically+change+a+study%27s+status\u0026amp;theme=623a240571fe7758758aabdc\u0026amp;signature=a778c840dad2aa68b102b1ca0664c640bbee218c282a718bd5a415f9bf952e31\">\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=\"Update a study status - Rally Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update the status of a study in your workspace. This is the only way to programatically change a study\u0026#x27;s status\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rallyuxr-21.mintlify.app/_mintlify/api/og/v2?division=Studies\u0026amp;title=Update+a+study+status\u0026amp;description=Update+the+status+of+a+study+in+your+workspace.+This+is+the+only+way+to+programatically+change+a+study%27s+status\u0026amp;theme=623a240571fe7758758aabdc\u0026amp;signature=a778c840dad2aa68b102b1ca0664c640bbee218c282a718bd5a415f9bf952e31\">\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/studies/update-a-study-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/studies/update-a-study-status.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/studies/update-a-study-status#webpage\",\"url\":\"https://docs.rallyuxr.com/api-reference/studies/update-a-study-status\",\"name\":\"Update a study status\",\"description\":\"Update the status of a study in your workspace. This is the only way to programatically change a study's status\",\"dateModified\":\"2026-08-20T15:04:40.861Z\",\"isPartOf\":{\"@id\":\"https://docs.rallyuxr.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rallyuxr.com/api-reference/studies/update-a-study-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rallyuxr.com/api-reference/studies/update-a-study-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Studies\",\"item\":\"https://docs.rallyuxr.com/api-reference/studies/create-a-new-study\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a study status\",\"item\":\"https://docs.rallyuxr.com/api-reference/studies/update-a-study-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rallyuxr.com/api-reference/studies/update-a-study-status#apireference\",\"headline\":\"Update a study status\",\"name\":\"Update a study status\",\"description\":\"Update the status of a study in your workspace. This is the only way to programatically change a study's status\",\"url\":\"https://docs.rallyuxr.com/api-reference/studies/update-a-study-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rallyuxr.com/api-reference/studies/update-a-study-status#webpage\"},\"dateModified\":\"2026-08-20T15:04:40.861Z\",\"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","description":"Update a study in your workspace. Only the fields provided will be updated. Certain features not supported and require updating in the UI","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","description":"Get a paginated list of screener or survey submissions and their question-level responses for a study. Optionally include question definitions to map question IDs to labels.","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","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","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":"Update a study status - Rally Developer Docs","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}