Skip to main content
POST
Create a form

Authorizations

Authorization
string
header
required

A Sorraia API key created in the dashboard (Settings → Integrations, under Programmatic API access). Pass it as Authorization: Bearer sor_live_.... API access is included with every paid plan; a key whose account is on the Free plan receives 402 plan_feature_gated.

Body

application/json
name
string
required
fields
object[]
required
Minimum array length: 1
type
enum<string>
default:standard
Available options:
standard,
multi-step
domainId
integer

Optional. Auto-picked when the account has exactly one verified domain.

webhookUrl
string<uri> | null

Response

The created form.

id
integer
required
name
string
required
type
enum<string>
required
Available options:
standard,
multi-step
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
domain
object | null

Bound domain, or null for legacy unbound forms.

submissionCount
integer

The form's submissions, counted as the submission lists return them: a submission held as likely spam is not counted until it is released. Present on the list, single-resource, create and update responses.

fields
object[]

The form's field schema. Present on the single-resource (detail) view only.