Skip to main content
POST
Submit a form (public)

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

24-char hex identifier of the target form.

Pattern: ^[a-fA-F0-9]{24}$
Example:

"{{objectId}}"

Body

application/json
language
string
required

Language code for storing this submission (e.g., "en"). Not validated against the form’s title keys by the service; use a configured code.

values
object
required

Key-value map where keys are form fields[].name. Validation rules per field type:

  • email: valid email
  • tel: international phone pattern
  • number: numeric value
  • checkbox/switch: boolean
  • multi-checkbox/multi-select: array
  • select: one of options[].value
captchaToken
string

CAPTCHA token received on the client from provider widget. Required only if the form has captcha.enabled=true.

Response

Submitted