Update the status of a study in your workspace. This is the only way to programatically change a study’s status
curl --request POST \ --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/status \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "status": "PAUSED" }'
{ "studyId": "<string>", "studyType": "SURVEY", "recruitmentStrategy": "IN_RALLY", "status": "DRAFT", "studyPlan": { "name": "<string>", "externalName": "<string>", "description": "<string>", "externalDescription": "<string>", "startDate": "2025-01-01", "endDate": "2025-01-02", "researchPlanUrl": "<string>", "participationLimit": 10, "consentFormId": "<string>", "incentive": { "incentiveType": "MONEY_OR_GIFT_CARD", "incentiveBudgetId": "<string>", "amount": 123, "customIncentiveId": "<string>", "defaultCustomIncentiveValue": "<string>" }, "includeScreener": true, "brandingConfigId": "<string>", "language": "en" }, "createdAt": "2023-11-07T05:31:56Z" }
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
The updated study
Study object