API version 2026-10-01 · beta
Build on API Platform
Keep contacts in step with your shop or CRM, send WhatsApp templates, work the inbox and get told when things happen. Read everything here; sign in to try it on your own account, safely in test mode.
Your first call
curl https://mcp.wa-api.cloud/v1/contacts?limit=5 \ -H "Authorization: Bearer $API_KEY"
Put your key in $API_KEY. A test key (ak_test_…) reads your real data and never changes anything.
What you can do
- Contacts
The people you talk to: find, create, update and import them.
16 operations
- Tags
Label contacts so you can find, filter and message them.
5 operations
- Contact groups
Audiences for broadcasts and filters: create groups and add or remove contacts.
6 operations
- Custom fields
The extra fields every contact can carry, such as a loyalty tier or an order count.
5 operations
- Messages
Send messages and read them: approved WhatsApp templates to one contact, free-form messages in a conversation while its reply window is open, and a conversation's message history.
6 operations
- Templates
Read, check, create and edit your WhatsApp templates.
7 operations
- Quick messages
Saved replies your team inserts in the inbox with a short code.
4 operations
- Short links
WhatsApp click-to-chat links with a QR code that open a chat with your number, message already typed.
5 operations
- Broadcasts
Read your broadcasts and their delivery numbers, and check whether you can send one.
3 operations
- Channels
Your connected WhatsApp numbers and other channels.
1 operations
- Conversations
Find and read conversations (with their reply window), add internal notes and reminders, tag, assign, close and reopen them. Sending and reading messages is under Messages.
11 operations
- Webhooks
Get told when things happen: endpoints, subscriptions, deliveries and replays.
18 operations
- Reports
Numbers for dashboards and nightly exports.
6 operations
Recipes
All recipes- R1: Order shipped → WhatsApp update with a tracking link
When your shop marks an order as shipped, send the customer an approved WhatsApp template with their tracking link.
- R2: Website lead form → contact, tag, welcome message, assign
A visitor fills in your website form; they become a tagged contact, get a welcome message, and the conversation lands with a sales rep.
- R3: Appointment reminders from a booking system or spreadsheet
Your own scheduled job reads tomorrow's bookings and sends each customer a reminder template.
- R4: Two-way CRM sync (HubSpot, Zoho, Salesforce…)
Push contacts from your CRM in bulk, keep single changes in step, and get told when contacts change here.
Keys
Keys are made in the app by someone who can manage settings. New keys can only read until you tick more.
Manage keysWebhooks
Get told when contacts, conversations and messages change. Every event is signed.
See the event catalog