Skip to main content
POST
Create a study (draft) from a guide

Authorizations

x-api-key
string
header
required

Body

application/json

Rules enforced by the server: at most one screening block and it must be first; screening blocks may contain only multiple_choice items and every option must carry a status; concept blocks require conceptSamplingConfig (>=1 concept) and other blocks must omit it; externalIds must be unique across blocks, items, options, and concepts; conditional questionId and carryForwardFrom must reference the externalId of an earlier item; concept conditionals must reference an item in a block before the concept block.

title
string
required
Minimum string length: 1
studyGuide
object[]
required
Minimum array length: 1
externalTitle
string
background
string
studyGoal
string
config
object
welcomeMessage
object
closingMessage
string

Response

Draft created

id
string<uuid>
required
status
enum<string>
required
Available options:
draft