Create a new Staff Message

post

https://api.servicem8.com/api_1.0/staffmessage.json

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. Existing attachment UUIDs require the read_attachments OAuth scope; multipart file uploads additionally require manage_attachments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Staff Message record to create

from_staff_uuid

uuid

required

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

to_staff_uuid

uuid

required

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

sent_timestamp

string

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_timestamp

string

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_timestamp

string

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.

message

string

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_uuid

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.

attached_json

string

JSON metadata associated with the message (e.g., attachments, extra context).

uuid

Unique identifier for this record

attachment_uuids

array of uuids

References to existing, fully-uploaded attachments.

attachment_uuids

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

201Staff message and multipart attachments created successfully

400Bad Request - The request is malformed or contains invalid parameters

401Unauthorized - Authentication credentials are missing or invalid

403Forbidden - You don't have permission to create this resource

413Uploaded files are too large

415Unsupported multipart upload filename

429Too Many Requests - You have exceeded the rate limit

500Internal Server Error - An unexpected error occurred on the server