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

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/studies
  • Auth: HTTP bearer

Request body

studyType'SURVEY' | 'INTERVIEWS' | 'UNMODERATED_TEST' | 'GROUP_INTERVIEW'

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

recruitmentStrategy'IN_RALLY' | 'EXTERNAL'

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

recruitmentPanelProvider'RESPONDENT' | 'USER_INTERVIEWS'

Set this to change the default recruitment panel provider when recruitment strategy is EXTERNAL. Defaults to User Interviews

idOfStudyToDuplicatestring

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

studyTemplateIdstring

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

teamIdstring

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

populationIdstring

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

Example request

{
  "studyPlan": {
    "startDate": "2025-01-01",
    "endDate": "2025-01-02"
  }
}

Response

The created study

studyIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.