Quick Start
Make your first API call and send a WhatsApp message in minutes
Authentication
Learn how to authenticate your API requests with Convo
Send Messages
Send text, images, videos, documents, and interactive messages
API Reference
Explore the full REST API with request/response examples
What You Can Build
Messaging
Send template messages, rich media, and interactive flows to your customers
Campaigns
Create API-driven campaigns and track delivery, read rates, and replies
Contacts
Manage your contact list with custom attributes, tags, and opt-in controls
Webhooks
Receive real-time notifications for message events and contact updates
Catalogues
Showcase your products with WhatsApp-native catalogue and shopping messages
Templates
Submit and manage WhatsApp Business Message Templates for approval
Get Started in 3 Steps
1
Get your API credentials
Log into your Convo dashboard, navigate to Settings, and copy your Project API Password (
X-API-WA-Project-API-Pwd). You’ll use this header on every API call.2
Create or find your Project ID
Every WhatsApp number on Convo is associated with a Project. Find your Project ID in the dashboard — it’s required as a path parameter for most API calls.
3
Send your first message
Call
POST /project/{project_id}/messages with a recipient phone number and a text body. See the Quick Start guide for a complete working example.Convo operates on top of the WhatsApp Business Platform. All outbound messages to users who haven’t messaged you first must use an approved Message Template. See Templates for details.
