Skip to main content
POST
Send a WhatsApp message

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer cb_live_.... Create one in Settings โ†’ API Keys. See public_api.md ยง 3 for scopes.

Body

to
string
required
Minimum string length: 1
type
enum<string>
required
  • template - TEMPLATE
  • text - TEXT
  • interactive - INTERACTIVE
  • audio - AUDIO
  • contacts - CONTACTS
  • document - DOCUMENT
  • image - IMAGE
  • location - LOCATION
  • order - ORDER
  • reaction - REACTION
  • sticker - STICKER
  • video - VIDEO
Available options:
template,
text,
interactive,
audio,
contacts,
document,
image,
location,
order,
reaction,
sticker,
video
text
any
interactive
object
audio
any
contacts
object[]
document
object
image
object
location
object
reaction
object
sticker
object
video
object
template
object
reply_to_wamid
string | null
whatsapp_business_account_id
integer

Provide the WhatsApp Business Account ID. If multiple accounts are present, provide the account ID otherwise it will be defaulted to the first account

phone_number
integer

If the provided business account has multiple phone numbers, provide the phone number ID

Response

201 - application/json
{key}
any