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-178a-4fa4-a1bb-2329bd3bc29b",
  "edit_date": "2025-08-01 12:00:00",
  "form_uuid": "123e4567-0db8-4602-b04f-2329b9b2d90b",
  "staff_uuid": "123e4567-721a-4295-82dc-2329bfa38f9b",
  "regarding_object_uuid": "123e4567-d4a5-4382-94f8-2329bdb8d27b",
  "timestamp": "2025-08-01 12:00:00",
  "form_by_staff_uuid": "123e4567-c7eb-4b86-9853-2329bcc0713b",
  "document_attachment_uuid": "123e4567-7e82-42cb-861a-2329b4d22dbb",
  "asset_uuid": "123e4567-c58c-40cf-8836-2329be5e6fab"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes