Skip to main content
POST
/
studies
/
{studyId}
/
status
Update a study status
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PAUSED"
}
'
{
  "studyId": "<string>",
  "studyType": "SURVEY",
  "recruitmentStrategy": "IN_RALLY",
  "status": "DRAFT",
  "studyPlan": {
    "name": "<string>",
    "externalName": "<string>",
    "description": "<string>",
    "externalDescription": "<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"
  },
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
studyId
string
required

Body

application/json
​
status
enum<string>
required

Statuses a study can be updated to via the API

Available options:
PAUSED,
CLOSED

Response

The updated study

Study object

​
studyId
string
required
​
studyType
enum<string>
required

The type of study

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

The recruitment strategy for the study

Available options:
IN_RALLY,
EXTERNAL
​
status
enum<string>
required

The status of the study

Available options:
DRAFT,
ACTIVE,
PAUSED,
CLOSED
​
studyPlan
object
required

Study plan object

​
createdAt
string<date-time>
required