Studies

Publish a draft study

Publish a draft study and all of its associated data (screener, questions, options), applying its pending draft changes and moving it out of DRAFT status so it goes live. This is the same publish action available in the Rally app.

post/studies/{studyId}/publish

Request

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

Path parameters

studyIdstring required

Response

The published 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.