Skip to main content
POST
Create form

Authorizations

x-api-key
string
header
required

Body

application/json
title
object
required

Map of language code → string (at least one entry required).

slug
string
required

URL-friendly, unique per tenant. Must satisfy the service’s slug rules (lowercase, digits, hyphens; no spaces).

sections
object[]
required

Ordered list of sections; each section contains fields.

Minimum array length: 1
description
object

Multilingual description (language code → string).

submitButtonText
object

Multilingual submit button label (language code → string).

isActive
boolean

Whether the form is enabled (default true).

formType
enum<string>

Whether the form is reachable on the public submit route. Defaults to "public"; "internal" forms are only submittable through /forms/{id}/internal-submit.

Available options:
public,
internal
captcha
object

Per-form CAPTCHA gate. enabled defaults to false. provider defaults to the service-wide CAPTCHA_PROVIDER_DEFAULT (falling back to "recaptcha"). minScore (0–1) applies to providers that return a score.

notification
object

Optional submission notifications. enabled defaults to false. email and push each take admin and submitter sub-objects whose enabled flags default to false. Notifications are fire-and-forget and never block or fail the HTTP response.

relation
object

Optional relation to other forms for multi-step flows.

Response

Created