Skip to main content
POST
Submit a form

Authorizations

x-api-key
string
header
required

Introw API key shown once when the credential is created.

Path Parameters

formId
string
required

Identifier of the form, shown in the form's share dialog and in the form URL. Form identifier, shown in the form's share dialog and in the form URL.

Minimum string length: 1

Body

application/json
fields
object
required

Submitted values keyed by form field id. Field ids are opaque, generated identifiers (for example qkzv8h2m4t6r1yc9pd3sxf70), never human-readable names. Fetch them from GET /api/v1/forms/{formId}/schema, which lists every field id with its label, whether it is required, the value shape to send, and the allowed values of every picklist. Values that fail the form's validation rules return 422; keys that don't match a field are ignored.

email

Email of the person submitting the form, when known. Used to resolve the submitter identity and, together with the form's identification automations, relate the submission to a partner.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
partnerId
string

Partner to relate the submission to. Accepts the Introw partner id or the partner's CRM external id. Returns 404 when it matches neither. When omitted, Introw makes a best effort to resolve the partner from the submitter email.

Minimum string length: 1
partnerObjects
object[]

CRM objects from the submitting partner's own CRM to link to the submission.

Response

Form was submitted successfully.

data
object
required