Skip to main content
POST
Resolve a Chat and send a Message

Authorizations

Authorization
string
header
required

Bearer token authentication. Include your API token in the Authorization header.

Format: Authorization: Bearer <your-token>

Headers

Idempotency-Key
string

Optional idempotency key for the send. Reuse the same key to safely retry without sending twice. May also be supplied as message.idempotency_key.

Maximum string length: 255

Body

application/json

Resolve or reuse the Chat for the recipient Handles, then send a Message as the authenticated Contact.

to
string[]
required
Required array length: 1 - 31 elements
message
object
required

The Message to send. Text, link, and media parts are supported. Voice memos use POST /v1/chats/{chatId}/voicememo.

Response

Message accepted for delivery

The resolved Chat and resulting Message.

chat_id
string<uuid>
required

The reused or newly created Chat.

created_new_chat
boolean
required
from
string
required

Handle of the authenticated sending Contact.

is_group
boolean
required

Whether the resolved chat is a group chat.

handles
object[]
required

Contacts in the resolved Chat.

message
object
required

The primary message that was sent.