Skip to main content
POST
Add Questionnaire

Body

application/json
name
string
required
Maximum string length: 255
handle
string | null
Maximum string length: 255
description
string | null
questionnaireable_type
string | null
Maximum string length: 255
questionnaireable_id
string | null
Maximum string length: 255
profile_id
string | null
purpose
enum<string>
Available options:
booking,
general,
waitlist,
walk_in,
pre_visit,
post_visit,
cancellation,
profile_onboarding,
interaction,
survey
is_active
boolean
meta
string[] | null
questions
object[]

Flat questions[]: every entry lands on the auto-created Page 1. Mutually exclusive with pages[] (validated in withValidator).

pages
object[]

Nested pages[]: structured form with explicit page boundaries. Each page holds its own questions[]. Mutually exclusive with top-level questions[] (validated in withValidator).

Minimum array length: 1

Response

Questionnaire

data
Questionnaire · object
required