Skip to main content
POST
Compose a new email or WhatsApp message

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. OAuth 2.0 authorization-code flows are not currently available.

Headers

Idempotency-Key
string

Stable 8–120 character key for safe mutation retries.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required

Body

application/json
contact_id
string<uuid>
required
channel
enum<string>
required
Available options:
web_chat,
email,
whatsapp
conversation_id
string<uuid>
reply_to_message_id
string<uuid>
subject
string
Maximum string length: 998
body
string
Maximum string length: 50000
attachment_ids
string<uuid>[]
Maximum array length: 10
template_id
string<uuid>
template_parameters
object[]
Maximum array length: 20

Response

Successful data envelope.

data
any
required
meta
object
required