Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Public API access token issued by /public/v1/oauth/token. Example: Authorization: Bearer fspt_.... Each resource request rechecks the token company's current provider access. Disabling access blocks existing tokens with 403 auth.provider_unavailable.

Headers

Idempotency-Key
string
required

Required for Public API write requests. Reusing the same key with the same method, path, and body replays the stored successful response; reusing it with a different request returns 409 idempotency.conflict.

Required string length: 1 - 200
Example:

"booking-create-20260714-001"

Body

application/json
name
object
required

Up to 25 languages per field. Valid BCP 47 keys are canonicalized; duplicate canonical keys and und are rejected. Every non-empty map must contain defaultLanguage. Required text cannot be empty. A supplied map replaces all languages for that field; {} clears an optional field. Null maps, null values and plain strings are rejected.

defaultLanguage
string
required

Required on create and on the first Public API update of a form without a declared default language. A canonical BCP 47 language tag, such as nl or en-GB; und is reserved for unknown-language responses. Every non-empty text map must include this language. When changing it, all retained maps must contain the new language. Declaring the language of an existing form assigns its source text to that language without translating it.

Maximum string length: 80
formType
enum<string>
required

Cannot be changed after creation.

Available options:
intake,
checkup
description
object

Up to 25 languages per field. Valid BCP 47 keys are canonicalized; duplicate canonical keys and und are rejected. Every non-empty map must contain defaultLanguage. Required text cannot be empty. A supplied map replaces all languages for that field; {} clears an optional field. Null maps, null values and plain strings are rejected.

sections
object[]

On update, replaces the complete sections array. Omit to preserve sections. Existing section/question IDs may be retained; duplicate or foreign IDs are rejected.

Response

Form created

data
object
required
meta
object
required