HomeGuidesAPI Reference
API Reference

Submit form data (V3)

Submits form data with support for deferred file uploads.

Integration Flow:

  1. Submit form data including file names for any file fields
  2. If files need uploading, response includes presigned S3 URLs (status: accepted)
  3. Upload files to S3 using the presigned URLs (multipart form POST)
  4. Call POST /:token/confirm to verify uploads and complete submission

Response Status:

  • completed: No files to upload, submission processed immediately
  • accepted: Files need uploading, use provided presigned URLs then call /confirm

File Upload:
When uploading to S3, send a multipart form POST to the url with:

  • All fields from the fields object as form fields
  • The file content as file field
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Session token

Query Params
string
required

The name of the entity that filled the form

Body Params

Form submission data

A flat object where each key is a field name and each value can be one of the following types:

  • string: Text values
  • number: Numeric values
  • boolean: true/false values
  • date: Unix timestamp (milliseconds since epoch)
  • stringList: Multiple string values
  • entity: Array of objects representing ownership relations
  • file: Filename as a string (file content uploaded separately via presigned URL)

NOTE: The UI in this documentation may only show "string" as the value type, but all types listed above are accepted. Check the examples.

The fields from the conditional type should be included in the root of the object.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json