Use this endpoint to send WhatsApp messages to customers. The payload shape in the content block changes depending on the message type you choose.
Headers
-
fieldstring(required) — Your workspace API key. Create one in the dashboard. -
fieldstring(required) — Set toapplication/json.
Request body
-
channel_idstring(required) — The ID of the WhatsApp channel sending the message. -
tostring(required) — Recipient phone number in international format (without the leading+). -
typestring(required) — The type of message being sent (e.g.text,image,template,buttons,list). -
contentobject(required) — The payload structure specific to the chosentype.
Message type guides
Select a guide below to view detailed specifications, parameters, and code examples for each message type:
Interactive & templates
- Send templates: Pre-approved notifications (order updates, OTPs).
- Send text: Plain text messages and conversation replies.
- Send buttons: Quick-reply buttons.
- Send list: Interactive picker menus.
Media attachments
- Send image: JPG/PNG photos with optional captions.
- Send video: MP4 video attachments.
- Send audio: Audio files and voice notes.
- Send document: PDF and other documents.
- Send sticker: static or animated WebP stickers.
Location & contacts
- Send location: Geographic coordinates (latitude/longitude) with pin.
- Request location: Ask the customer to share their location coordinates.
- Send contact: Share contact card information.
Actions
- Send reaction: Add an emoji reaction to a message.
- Mark read: Mark inbound messages as read.