Quick Start
Send your first WhatsApp message in under five minutes.
Authentication
Generate an API key and authenticate every request.
Guides
Step-by-step walkthroughs for leads, messaging, follow-ups, agents, and webhooks.
API Reference
Full reference for every endpoint, parameter, and response schema.
What you can build
Lead Sync
Keep your CRM and Cordialy in sync — create, update, and query leads programmatically.
Outbound Messaging
Send templated or freeform WhatsApp messages directly to any lead.
Automated Follow-ups
Schedule and cancel follow-up messages based on events in your own system.
Real-time Webhooks
React instantly when a lead replies, converts, or changes status.
Get started in four steps
Generate an API key
In the Cordialy platform go to Integrations → API Keys and click New key. Copy the key — it is shown only once.
Create or import a lead
Call
POST /leads with the customer’s phone number. If a lead with that number already exists, the API returns the existing record — no duplicates.Send a WhatsApp message
Call
POST /leads/{leadId}/messages with your message text. It is delivered via WhatsApp and logged in the platform with the Via API tag.Plan access
Some endpoints require an Enterprise or Enterprise Plus plan. The table below shows which resources are available on each plan.| Resource | Growth | Enterprise | Enterprise Plus |
|---|---|---|---|
| Leads & Messages | ✅ | ✅ | ✅ |
| Follow-ups | ✅ | ✅ | ✅ |
| AI Agents | — | ✅ | ✅ |
| Reports | — | ✅ | ✅ |
| Webhooks | — | ✅ | ✅ |
All API requests must include the
X-API-Key header. See Authentication for details.