Update a study
Update a study in your workspace. Only the fields provided will be updated. Certain features not supported and require updating in the UI
curl --request PATCH \
--url https://api.rallyuxr.com/api/public/v1/studies/{studyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"studyPlan": {
"externalName": "<string>",
"description": "<string>",
"startDate": "2025-01-01T00:00:00Z",
"endDate": "2025-01-02T00:00:00Z",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>",
"incentiveType": "MONEY_OR_GIFT_CARD"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en",
"name": "<string>"
}
}'{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01T00:00:00Z",
"endDate": "2025-01-02T00:00:00Z",
"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"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
The external name of the study
The internal description of the study
The start date of the study in ISO 8601 in UTC(with no offset). The time is truncated
The end date of the study in ISO 8601 in UTC(with no offset). The time is truncated
The URL of the research plan
The participation limit of the study
The ID of the consent form
The ID of the incentive budget. Not used for CUSTOM
The amount of the incentive. If type is CUSTOM use this for MONETARY types instead of default value
If type is CUSTOM then the ID of the custom incentive
If type is CUSTOM then the default value of the custom incentive
Incentive types that can be created by the API
MONEY_OR_GIFT_CARD, CUSTOM, CHARITY Whether to include a screener. If type is SURVEY the default is true, if not then false
The ID of the branding configuration
The language code for the study
en, es, fr, it, ro, pt, pl, de, nl, ja The internal name of the study
Response
Study object
The type of study
SURVEY, INTERVIEWS, UNMODERATED_TEST, GROUP_INTERVIEW The recruitment strategy for the study
IN_RALLY, EXTERNAL The status of the study
DRAFT, ACTIVE, PAUSED, CLOSED Study plan object
The internal name of the study
The external name of the study
The internal description of the study
The external description of the study
The start date of the study in ISO 8601 in UTC(with no offset). The time is truncated
The end date of the study in ISO 8601 in UTC(with no offset). The time is truncated
The URL of the research plan
The participation limit of the study
The ID of the consent form
The incentive details for the study
The type of incentive
MONEY_OR_GIFT_CARD, MONEY_OR_GIFT_CARD_WITH_TREMENDOUS, EXTERNAL_MONEY_OR_GIFT_CARD, CHARITY, CUSTOM, RESPONDENT_MONEY, RECRUITMENT_FEE The ID of the incentive budget
The amount of the incentive
If type is CUSTOM then the ID of the custom incentive
If type is CUSTOM then the default value of the custom incentive
Whether to include a screener. If type is SURVEY the default is true, if not then false
The ID of the branding configuration
The language code for the study
en, es, fr, it, ro, pt, pl, de, nl, ja curl --request PATCH \
--url https://api.rallyuxr.com/api/public/v1/studies/{studyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"studyPlan": {
"externalName": "<string>",
"description": "<string>",
"startDate": "2025-01-01T00:00:00Z",
"endDate": "2025-01-02T00:00:00Z",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>",
"incentiveType": "MONEY_OR_GIFT_CARD"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en",
"name": "<string>"
}
}'{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01T00:00:00Z",
"endDate": "2025-01-02T00:00:00Z",
"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"
}