Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
form_id
string
required

Form ID being submitted

email
string
required

Respondent email address. Used to upsert a Customer and, as a convenience, auto-fills the form's email field if no answer is provided for it.

answers
object
required

Map of form_field id → answer value. Optional for simple email-only forms — pass {} and rely on the email auto-fill. A consent field takes true when the person ticked it.

name
string | null

Respondent name (defaults to email local-part if omitted). Auto-fills the form's first text field when present and not otherwise supplied via answers.

ip_address
string | null

The submitter's IP address, kept with the submission as a record of the signup.

Response

Form submission created

id
string
required
object
string
required
answers
object[]
required
respondent_type
string
required
confirmation_requested_at
string<date-time> | null
required
confirmed_at
string<date-time> | null
required
delivered_at
string<date-time> | null
required
created_at
string<date-time>
required
respondent_id
string
required
form_id
string
required