Studies
Create a new study
Create a new study in your workspace. This can only be a draft study, certain features not supported and require updating in the UI
POST
/
studies
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"idOfStudyToDuplicate": "<string>",
"studyTemplateId": "<string>",
"owners": {
"userIds": [
"<string>"
],
"includeSelf": false
},
"teamId": "<string>",
"populationId": "<string>",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<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"
}
}'
{
"studyId": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Create study input
Response
201
application/json
The created study
The response is of type object
.
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"idOfStudyToDuplicate": "<string>",
"studyTemplateId": "<string>",
"owners": {
"userIds": [
"<string>"
],
"includeSelf": false
},
"teamId": "<string>",
"populationId": "<string>",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<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"
}
}'
{
"studyId": "<string>"
}