Skip to main content
POST
Update a study status

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
createdFromTemplateId
string | null
required

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

owners
object[]
required