Sign in
Form Responses

Create a new Form Response

OAuth Scope

This endpoint requires the following OAuth scope manage_forms.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/formresponse.json

Request body

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

form_uuidstring uuid
staff_uuidstring uuid
regarding_objectstring
regarding_object_uuidstring uuid
field_datastring

JSON array of form answers captured at submission time.

timestampstring
form_by_staff_uuidstring uuid
document_attachment_uuidstring uuid
asset_uuidstring uuid

Example request

{
  "uuid": "123e4567-6a7a-4a98-95ae-23312b62b7eb",
  "edit_date": "2025-09-01 12:00:00",
  "form_uuid": "123e4567-beb4-41e6-8929-233129f77f0b",
  "staff_uuid": "123e4567-4791-42aa-a5a9-23312ccab97b",
  "regarding_object_uuid": "123e4567-363e-421e-8bc1-2331269e96db",
  "timestamp": "2025-09-01 12:00:00",
  "form_by_staff_uuid": "123e4567-5966-4b7d-8b7e-23312a32078b",
  "document_attachment_uuid": "123e4567-ef72-4ac3-b31a-233127cdf44b",
  "asset_uuid": "123e4567-2e09-483a-83a1-2331238f123b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes