Send a Client Message

Overview

Sends a message from the authenticated client to the business. The message direction is always client_to_business — it is set automatically by the server based on the client token.

The staff member who receives the message is auto-assigned based on the business's assignment rules and the client's existing relationships.

Authentication

Available for Client tokens only. The client UID and business UID are extracted from the token — no need to pass them in the request body.

Parameters

  • message.message (required) — The text content of the message.
  • message.subject (optional) — An optional subject line for the message.
  • message.entity (optional) — Entity attachment that controls message type. When omitted, defaults to a plain text message. Set type to "document" and provide uid to attach an existing document.
  • matter_uid (optional) — The UID of the conversation (matter/engagement) to add the message to. If omitted, the system uses the client's default conversation.
Body Params
message
object
required

Message payload wrapper.

string

UID of the conversation (matter/engagement) to add the message to. If omitted, the system uses the client's default conversation.

Responses

401

Unauthorized — invalid or missing client token.

422

Unprocessable Entity — validation error (e.g., missing message text, invalid matter_uid).

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