Skip to main content

SubmitForm validates the values against the form's published schema, persists an immutable submission row with the schema snapshot, and applies any configured write-back to contact / account custom fields in the same transaction.

POST 

/api/v1/crm/forms/:formDefinitionId/submissions

The HTTP path's form_definition_id and the request body's form_definition_id must match.

Errors:

  • UNAUTHENTICATED: missing auth context.
  • NOT_FOUND: form does not exist (ErrFormNotFound); contact or account subject does not exist (ErrContactNotFound, ErrAccountNotFound).
  • FAILED_PRECONDITION: form is not in published status — drafts and archived forms cannot accept submissions (ErrFormNotPublished).
  • INVALID_ARGUMENT: values reference an unknown field key (ErrFormFieldUnknown); a required field is missing (ErrFormFieldRequired); a value fails per-type validation (ErrCustomFieldValidationFailed); a file_upload references an upload outside the caller's org (ErrFormInvalidUpload); file upload validation failed (ErrFormFileValidationFailed).

Request

Responses

A successful response.