Get customers
Answer customers
Work for you
Reach people
Give agents tools
Run and ship
Send and schedule WhatsApp messages, manage contacts and labels, and read conversations and templates
Read the organization, API key grants, number access and plan.
List business numbers accessible to this key.
2 fields
Read a business number.
1 field
List message templates and optionally filter by number, name, language or status.
6 fields
Read a template and the variables needed to send it.
Send text or a template. Inspect data.status and data.error even after HTTP 201.
9 fields
List messages with their provider delivery status.
10 fields
Read a message, including its current send status and error.
List conversations, optionally filtering unread messages and session windows.
11 fields
Read a conversation and its 24-hour window.
Read one page of messages, notes and other timeline entries.
5 fields
Mark a conversation read or unread in the inbox.
Add an internal note visible only to the team.
3 fields
Schedule text or a template. Text still needs an open window when it fires.
List scheduled messages and their outcomes.
Read a scheduled message and how it ended.
Cancel a pending scheduled message.
Find contacts by address, label, updated time or search text.
8 fields
Find or create a contact by phone or Business-Scoped User ID.
4 fields
Read a contact, labels and notes.
Update a contact's name or notes. Null or an empty string clears a note.
Add an existing label to a contact by its ID or exact name.
Remove a label from a contact.
List labels available to the organization.
Create a label. Empty number_ids makes it available on every number.