Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

Bot token (wc_bot_live_… or wc_bot_test_…) from the OAuth install

Headers

Idempotency-Key
string
required

Unique per message and destination: 1 to 255 visible ASCII characters, no spaces

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]+$
Example:

"evt_88231:usr_9a1"

Body

application/json

The message

text
string
required

What people see, and the push notification's text. Always send it.

Required string length: 1 - 4000
to
object
required

user with a usr_ id sends a direct message; conversation with a grp_ or chn_ id from GET /v1/conversations posts there

blocks
PublicApiBlock · object[]

Rich layout, at most 16 KB. Stored now and shown from a later release.

Maximum array length: 50
metadata
object

Your own data, at most 4 KB, stored with the message. Never shown in the app, but not secret: do not put credentials in it.

thread_id
string | null

A message in the same destination to reply to. It is quoted above the new message.

Accepted and ignored: App messages never unfurl links

Response

The message was sent, or this is a repeat of a send with the same key and body

message
object
required
ok
enum<boolean>
required
Available options:
true