Skip to main content
POST
Create a qualification library question

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Body

application/json

create body for a qualification question — the question fields, FLAT (no wrapper object). Your brand comes from your API key, and the platform derives the therapy context from the offering itself, so the body carries neither. The question id is server-minted; a client-sent id is ignored.

control
enum<string>
required
Available options:
single_select_cards,
multi_select_cards,
scale,
number,
number_pair,
date,
text,
long_text,
file_capture,
address,
phone,
email,
search_select
copy
object
required

your display copy — the question wording rides the prompt slot (required)

fact
string
required

the stable code of the catalog fact this question collects (must resolve)

option_labels
object

your per-option labels, keyed by stable option code (labels never bind logic)

options
string[]

stable option codes offered as answers — a subset of the bound fact's own codes

required
boolean
when
object

an optional condition — show this question only when an earlier screening answer calls for it. See the same field on the question shape for the full rules.

Response

the created library question

the saved question under data, plus non-blocking duplicate notices when another question already collects the same fact (the write still succeeds — warnings never block)

data
object
required

A client-authored screening question — a library definition or an offering-local copy. It binds a fact by its stable code (the code must resolve in your authoring fact catalog) and a display control, and carries your own wording. Copy and option labels are yours to author.

warnings
object[]