Skip to main content
PATCH
Update Study settings or lifecycle status

Authorizations

Authorization
string
header
required

Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.

Headers

If-Match
string
required

Quoted Study version last read from ETag or Study.version. Required on mutating Study writes.

Example:

"\"126300\""

Path Parameters

studyId
string<uuid>
required

Body

application/json

Updates Study settings or performs one lifecycle transition. Settings and status cannot be changed together.

name
string
Minimum string length: 1
appearance
object

A partial appearance update for an in-product Study.

responseSettings
object

Partial response-setting update. Omitted fields preserve their current values.

status
enum<string>
Available options:
IN_PROGRESS,
PAUSED,
COMPLETED,
ARCHIVED

Response

No Content