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-e2c5-4751-afbd-233122712a2b",
  "edit_date": "2025-09-01 12:00:00",
  "form_uuid": "123e4567-011e-45bf-b9f8-2331261f927b",
  "staff_uuid": "123e4567-1a3b-47f0-a5d2-233128d9183b",
  "regarding_object_uuid": "123e4567-676f-4319-8733-23312bd1387b",
  "timestamp": "2025-09-01 12:00:00",
  "form_by_staff_uuid": "123e4567-3182-4fc5-a180-23312167dbab",
  "document_attachment_uuid": "123e4567-1161-42d9-a0dd-23312ecbb46b",
  "asset_uuid": "123e4567-4a96-4031-9e2a-23312d60045b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes