Sign in
Notes

Create a new Note

OAuth Scope

This endpoint requires the following OAuth scope publish_job_notes.

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

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-d94e-45df-a19f-2342236ef44b",
  "related_object_uuid": "123e4567-1b7e-47aa-9912-23422bda8f4b",
  "action_completed_by_staff_uuid": "123e4567-e997-4bec-8f8e-2342275255fb",
  "edit_by_staff_uuid": "123e4567-e6bd-452d-91a7-234227acaefb",
  "create_date": "2025-09-01 12:00:00"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes