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

from_staff_uuidstring uuid

Unique identifier (UUID) of the staff member who sent this message. Identifies the sender of the communication within the system.

to_staff_uuidstring uuid

Unique identifier (UUID) of the staff member who received this message. Identifies the intended recipient of the communication.

sent_timestampstring

The date and time when the message was sent. Format is YYYY-MM-DD HH:MM:SS. This field is automatically set to the current time when a new message is created.

delivered_timestampstring

The date and time when the message was delivered to the recipient's device. Format is YYYY-MM-DD HH:MM:SS. This field may be null if delivery confirmation is not available.

read_timestampstring

The date and time when the message was read by the recipient. Format is YYYY-MM-DD HH:MM:SS. This field may be null if the message has not been read or if read receipts are not available.

messagestring

The text content of the message. Supports Unicode characters for international language support. This field contains the actual message being sent between staff members.

regarding_job_uuidstring uuid

Unique identifier (UUID) of the job this message is related to. Optional field that links the message to a specific job for context. This field may be null if the message is not related to a specific job.

uuidstring uuid

Unique identifier for this record

attached_jsonstring

Example request

{
  "from_staff_uuid": "123e4567-dbcd-4d87-b0ee-234824ab55bb",
  "to_staff_uuid": "123e4567-e0e9-43f9-946e-23482ac8d7bb",
  "sent_timestamp": "2025-09-01 12:00:00",
  "delivered_timestamp": "2025-09-01 12:00:00",
  "read_timestamp": "2025-09-01 12:00:00",
  "regarding_job_uuid": "123e4567-c6a6-4c5a-86ed-23482b199f5b",
  "uuid": "123e4567-1a26-4f4f-b03c-23482dda98eb"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes