Sign in
Notes

Create a new Note

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/note.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

related_objectstring
related_object_uuidstring uuid
notestring
action_requiredstring
action_completed_by_staff_uuidstring uuid
edit_by_staff_uuidstring uuid

UUID of Staff Member who last modified record

create_datestring

Timestamp at which record was last modified

Example request

{
  "uuid": "123e4567-64ba-43f8-b962-231cf78e80cb",
  "edit_date": "2025-08-01 12:00:00",
  "related_object_uuid": "123e4567-2de7-4f1e-9ec0-231cf32bab3b",
  "action_completed_by_staff_uuid": "123e4567-3f9b-4668-92ab-231cfb2c79cb",
  "edit_by_staff_uuid": "123e4567-2a6d-4f2e-891b-231cf8fdbfdb",
  "create_date": "2025-08-01 12:00:00"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes