Notes

Create a new Note

Changed on

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

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/note.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: publish_job_notes

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-e987-4c15-8af5-23f948cf3d7b",
  "related_object_uuid": "123e4567-c33e-4f75-b941-23f9419f61bb",
  "action_completed_by_staff_uuid": "123e4567-f36e-4657-933d-23f945f1fdab",
  "edit_by_staff_uuid": "123e4567-6b41-43bf-a15e-23f94969bfab",
  "create_date": "2026-03-01 12:00:00"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes