Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public id of a conversation the member can see.

Body

application/json
text
string
required

Required unless the message has attachments.

Required string length: 1 - 10000
Pattern: \S
reply_to_id
string<uuid>

A message in this conversation the member can read.

client_message_id
string

An id the client chooses. A retry with the same id returns the message already sent, with 200, instead of sending it again.

Required string length: 1 - 100
attachments
object[]

Files the client has uploaded, named by URL, as the legacy message endpoint takes them. The URL is not checked as an owned upload.

Maximum array length: 10

Response

The message already sent with this client_message_id, without text or attachments if it was deleted.

One message.

status
integer
required
data
object
required

One message as the signed-in member sees it.

meta
object
required

Envelope metadata present on every response.