> ## Documentation Index > Fetch the complete documentation index at: https://docs.rallyuxr.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a study status > Update the status of a study in your workspace. This is the only way to programatically change a study's status ## OpenAPI ````yaml https://api.rallyuxr.com/api/openapi post /studies/{studyId}/status openapi: 3.1.0 info: title: Rally UXR Developer Docs version: '1.0' servers: - url: https://api.rallyuxr.com/api/public/v1 security: - bearerAuth: [] tags: - name: Forms description: Operations on Forms in your workspace - name: People description: Operations on Person's stored in your workspace - name: Person Properties description: Operations on workspace level Person Properties - name: Populations description: Operations on Populations in your workspace - name: Segments description: Operations on Segments in your workspace - name: Studies description: Operations on Studies in your workspace - name: Participants description: Operations on Participants in studies - name: Screener description: Operations on a study's screener - name: Consent Submissions description: Operations on Consent Submissions for studies - name: Incentives description: Operations on Incentives in your workspace - name: Messages description: Operations on Message activities in your workspace - name: Imports description: Operations on Imports in your workspace - name: Users description: Operations on Workspace Users - name: Teams description: Operations on Teams in your workspace - name: Backfills description: >- Routes that can be used to backfill data into Rally. If you'd like access to these apis, please reach out to your Customer Success rep - name: Person description: Deprecated, use People paths: /studies/{studyId}/status: post: 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 parameters: - $ref: '#/components/parameters/StudyId' 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 required: - status responses: '200': description: The updated study headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Study' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequestError' '401': description: Unauthorized headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: text/plain: schema: type: string example: Unauthorized '403': description: Forbidden headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: text/plain: schema: type: string example: Forbidden '404': description: Not Found content: text/plain: schema: type: string example: '{Resource} not found' '429': description: Too Many Requests headers: Retry-After: $ref: '#/components/headers/Retry-After' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: text/plain: schema: type: string example: Too Many Requests '500': description: Internal Server Error headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: text/plain: schema: type: string example: Internal Server Error security: - bearerAuth: [] components: parameters: StudyId: schema: $ref: '#/components/schemas/StudyId' required: true name: studyId in: path 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 Retry-After: description: The number of seconds until the client should retry the request. schema: type: integer format: int32 schemas: Study: type: object properties: studyId: type: string studyType: allOf: - $ref: '#/components/schemas/StudyType' - description: The type of study recruitmentStrategy: allOf: - $ref: '#/components/schemas/RecruitmentStrategy' - description: The recruitment strategy for the study status: $ref: '#/components/schemas/StudyStatus' studyPlan: $ref: '#/components/schemas/StudyPlan' createdAt: type: string format: date-time createdFromTemplateId: type: - string - 'null' description: >- The ID of the template this study was created from, or null if not created from a template owners: type: array items: $ref: '#/components/schemas/StudyOwner' required: - studyId - studyType - recruitmentStrategy - status - studyPlan - createdAt - createdFromTemplateId - owners description: Study object BadRequestError: type: object properties: errors: type: array items: type: object properties: message: type: string path: type: array items: anyOf: - type: string - type: number required: - message - path required: - errors description: Error response for a bad request with details on what was invalid StudyId: type: string StudyType: type: string enum: - SURVEY - INTERVIEWS - UNMODERATED_TEST - GROUP_INTERVIEW description: The type of study. Required if not using a duplicate/study template RecruitmentStrategy: type: string enum: - IN_RALLY - EXTERNAL description: >- The recruitment strategy for the study. Required if not using a duplicate/study template StudyStatus: type: string enum: - DRAFT - ACTIVE - PAUSED - CLOSED description: The status of the study StudyPlan: type: object properties: name: type: - string - 'null' description: The internal name of the study externalName: type: - string - 'null' description: The external name of the study description: type: - string - 'null' description: The internal description of the study externalDescription: type: - string - 'null' description: The external description of the study startDate: anyOf: - type: string format: date description: The start date of the study in YYYY-MM-DD format example: '2025-01-01' - type: string format: date-time description: >- The start date of the study in ISO 8601 in UTC(with no offset). The time is truncated example: '2025-01-01T00:00:00Z' deprecated: true - type: 'null' endDate: anyOf: - type: string format: date description: The end date of the study in YYYY-MM-DD format example: '2025-01-02' - type: string format: date-time description: >- The end date of the study in ISO 8601 in UTC(with no offset). The time is truncated example: '2025-01-02T00:00:00Z' deprecated: true - type: 'null' researchPlanUrl: type: - string - 'null' description: The URL of the research plan participationLimit: type: - number - 'null' default: 10 description: The participation limit of the study consentFormId: type: - string - 'null' description: The ID of the consent form incentive: $ref: '#/components/schemas/StudyPlanIncentive' includeScreener: type: boolean description: >- Whether to include a screener. If type is `SURVEY` the default is true, if not then false brandingConfigId: type: - string - '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. language: $ref: '#/components/schemas/LanguageCode' scheduler: $ref: '#/components/schemas/StudyPlanScheduler' required: - name - externalName - description - externalDescription - startDate - endDate - researchPlanUrl - participationLimit - consentFormId - incentive - includeScreener - brandingConfigId - language description: Study plan object StudyOwner: type: object properties: userId: type: string emailAccountId: type: string fullname: type: - string - 'null' email: type: - string - 'null' required: - userId - emailAccountId - fullname - email description: Study owner object StudyPlanIncentive: type: - object - 'null' properties: incentiveType: $ref: '#/components/schemas/IncentiveType' incentiveBudgetId: type: - string - 'null' description: The ID of the incentive budget amount: type: - number - 'null' description: The amount of the incentive currency: allOf: - $ref: '#/components/schemas/IncentiveCurrencyType' - description: The currency of the incentive customIncentiveId: type: - string - 'null' description: If type is CUSTOM then the ID of the custom incentive defaultCustomIncentiveValue: type: - string - '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 LanguageCode: 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 StudyPlanScheduler: type: - object - '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). 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 IncentiveCurrencyType: type: string enum: - USD - EUR - GBP - CAD - AUD - NZD description: The currency of the incentive. Defaults to USD when not provided securitySchemes: bearerAuth: type: http scheme: bearer ````