Studies

Update a study status

Update the status of a study in your workspace. This is the only way to programatically change a study's status

post/studies/{studyId}/status

Request

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

Path parameters

studyIdstring required

Request body

status'PAUSED' | 'CLOSED' required

Statuses a study can be updated to via the API

Response

The updated study

studyIdstring required
studyType'SURVEY' | 'INTERVIEWS' | 'UNMODERATED_TEST' | 'GROUP_INTERVIEW' required

The type of study

recruitmentStrategy'IN_RALLY' | 'EXTERNAL' required

The recruitment strategy for the study

status'DRAFT' | 'ACTIVE' | 'PAUSED' | 'CLOSED' required

The status of the study

createdAtstring date-time required
createdFromTemplateIdstring nullable required

The ID of the template this study was created from, or null if not created from a template

Example response

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

Changes

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