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-d9d7-4cbb-ba6f-233c62baeb0b",
  "related_object_uuid": "123e4567-40b5-497d-8ece-233c6e25516b",
  "action_completed_by_staff_uuid": "123e4567-2d98-4796-b616-233c6f78634b",
  "edit_by_staff_uuid": "123e4567-2017-4a41-89ca-233c619ceb1b",
  "create_date": "2025-09-01 12:00:00"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes