Skip to main content
POST
Create a Question

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

Supported Question input for the Study creation API.

title
object
required

The authored title accepted when creating a Question.

type
enum<string>
required
Available options:
OPEN_TEXT
name
string

Optional stable caller-defined name, unique within the Study.

Required string length: 1 - 128
required
boolean
default:false

Whether the respondent must answer the Question.

randomizePosition
boolean

Whether this Question participates in layout-position randomization. Defaults to false.

position
object

Placement relative to a Question or Block in the Study. BEFORE a Block uses that Block's slot. AFTER a Block lands after its subtree.

blockId
string<uuid>

Public UUID of the Block that will contain this Question.

description
object

Optional respondent-facing description shown with a Question.

image
object

Attaches a QUESTION_IMAGE recorded on this Study. A Consent / Legal question can have this and a consent document.

responsePlaceholder
string

Placeholder shown in the response field.

Response

Created

Canonical Question resource.

id
string<uuid>
required
title
object
required

Canonical rich-text Question title.

required
boolean
required
displayLogic
Condition · object
required

A single typed condition. Operators that inspect answer state omit value; choice comparisons use immutable Option values.

skipLogic
object[]
required

Ordered skip rules, limited to 20. An empty array clears skip logic.

Maximum array length: 20
aiFollowUp
object | null
required
randomizePosition
boolean
required
type
enum<string>
required
Available options:
OPEN_TEXT
name
string
description
object

Canonical respondent-facing Question description.

image
object

The image shown with a Question. Omitted when the Question has no image.

responsePlaceholder
string

Placeholder shown in the response field.