Create a new study

post https://api.rallyuxr.com/api/public/v1/studies

Create a new study in your workspace. This can only be a draft study, certain features not supported and require updating in the UI

Body Params

studyType

string

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

recruitmentStrategy

string

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

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

studyPlan

object

required

Study details

Responses

Language

Credentials

Bearer


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://api.rallyuxr.com/api/public/v1/studies \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "owners": {
8
    "includeSelf": false
9
  },
10
  "studyPlan": {
11
    "participationLimit": 10,
12
    "incentive": {
13
      "incentiveType": "MONEY_OR_GIFT_CARD"
14
    },
15
    "language": "en"
16
  }
17
}
18
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

201The created study

400Bad Request

401Unauthorized

403Forbidden

404Not Found

429Too Many Requests

500Internal Server Error