Skip to main content
POST
/
studies
Create a new study
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/studies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  },
  "studyType": "SURVEY",
  "recruitmentStrategy": "IN_RALLY",
  "idOfStudyToDuplicate": "<string>",
  "studyTemplateId": "<string>",
  "owners": {
    "userIds": [
      "<string>"
    ],
    "includeSelf": false
  },
  "teamId": "<string>",
  "populationId": "<string>"
}
'
{
  "studyId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create study input

​
studyPlan
object
required

Study details

​
studyType
enum<string>

The type of study. Required if not using a duplicate/study template

Available options:
SURVEY,
INTERVIEWS,
UNMODERATED_TEST,
GROUP_INTERVIEW
​
recruitmentStrategy
enum<string>

The recruitment strategy for the study. Required if not using a duplicate/study template

Available options:
IN_RALLY,
EXTERNAL
​
idOfStudyToDuplicate
string

The ID of the study to duplicate. Cannot be used with studyTemplateId. Values within the studyPlan will override any values from the duplicated study

​
studyTemplateId
string

The id of the study template. Cannot be used with idOfStudyToDuplicate. Values within the studyPlan will override any values from the template study

​
owners
object
​
teamId
string

The ID of the team to associate the study with. Required in Rally For Teams

​
populationId
string

ID of the population where new study sign ups will go to if the study public link is active

Response

The created study

​
studyId
string
required