Skip to main content
POST
chat.message.post

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
text
string
required

The message text, up to 40000 characters.

Required string length: 1 - 40000
accountId
string

The connected business account, from local.locations.list. Optional when only one is connected.

Required string length: 1 - 256
channelId
string

Channel to post to, for community servers that have several. Team workspace accounts post to the channel chosen when you connected them and do not take a channelId.

Required string length: 1 - 64

Response

The result

status
enum<string>
required

Posted, or still pending.

Available options:
posted,
pending