Skip to main content
POST
Send a message

Authorizations

X-API-KEY
string
header
required

Body

application/json

Message to send

channelId
string<uuid>
required

ChannelID identifies the channel the message is sent to. Required. Must be a bare UUID and must not include the GetStream 'messaging:' prefix.

Example:

"550e8400-e29b-41d4-a716-446655440000"

text
string
required

Text is the body of the message. Required. Limited to 5000 characters by GetStream.

Example:

"Thanks for the update, I'll review the contract today."

senderId
string<uuid>

SenderID optionally overrides the author of the message. When omitted, the authenticated user is used. When set it must be the UUID of a member of the channel.

Example:

"550e8400-e29b-41d4-a716-446655440001"

Response

OK

channelId
string<uuid>

ChannelID is the channel the message belongs to (bare UUID, without the GetStream 'messaging:' prefix).

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt
string
creatorId
string
data
string
id
string
identityId
string
isAttachmentIncluded
boolean

IsAttachmentIncluded indicates whether the message has one or more attachments.

Example:

false

object
string

Object is the resource type discriminator, always "message".

Example:

"message"

previousAttributes
object
ref
string
senderId
string<uuid>

SenderID is the UUID of the member who authored the message.

Example:

"550e8400-e29b-41d4-a716-446655440001"

text
string

Text is the body of the message. Empty when the message only carries attachments.

Example:

"Thanks for the update, I'll review the contract today."

updatedAt
string