GuidesAPI ReferenceDiscussions
API Reference

Update a Staff Message

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

OAuth Scope

This endpoint requires the following OAuth scope publish_messages.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the Staff Message

Body Params

Staff Message fields to update

uuid

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

uuid

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

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.

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.

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.

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.

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.

uuid

Unique identifier for this record

string
Responses

Updated 8 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago