Skip to main content
POST
Submit a form from the backend (internal)

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 this submission is stored under (e.g. "en", "fa"). Defaults to "fa" when omitted.

values
object
required

Key-value map where keys are the form's sections[].fields[].name. Field rules are enforced server-side (406 on violation):

  • fields with required: true must be present and non-empty
  • fields with disabled: true must be absent
  • type is checked per field type (email, tel, number, checkbox/switch boolean, multi-checkbox/multi-select array, select must match an options[].value)
  • a field with a relation must contain existing submission ids of the target form; one-to-one and many-to-one take a single id string, one-to-many and many-to-many take a non-empty array of id strings
status
enum<integer>

Initial status. Honoured on this route only (ignored on the public submit route). Defaults to 0 (pending) when omitted.

Available options:
0,
1,
2
captchaToken
string

Accepted but not verified on this route — CAPTCHA checks are skipped for the internal channel.

Response

Submitted