Sign in
Staff Messages

Create a new Staff Message

OAuth Scope

This endpoint requires the following OAuth scope publish_messages.

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

from_staff_uuidstring uuid
to_staff_uuidstring uuid
sent_timestampstring
delivered_timestampstring
read_timestampstring
messagestring
regarding_job_uuidstring uuid
attached_jsonstring

Example request

{
  "uuid": "123e4567-abdb-4322-a8df-2329b5ae407b",
  "edit_date": "2025-08-01 12:00:00",
  "from_staff_uuid": "123e4567-b98e-4778-9bb6-2329bbb2e71b",
  "to_staff_uuid": "123e4567-3660-4750-950f-2329ba6dacab",
  "sent_timestamp": "2025-08-01 12:00:00",
  "delivered_timestamp": "2025-08-01 12:00:00",
  "read_timestamp": "2025-08-01 12:00:00",
  "regarding_job_uuid": "123e4567-33ad-4fc3-81e6-2329b4763b1b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes