REST API
Reference
Build powerful integrations with Cincht's fully-documented REST API. Send messages, manage contacts, automate workflows, and analyse results.
API version
v1
Protocol
HTTPS REST
Rate limit
1000 req/min
SDKs
6 languages
Up and running in 3 steps
Get your API key
Sign up and navigate to Settings β API Keys β Create New Key. Keep it secret and never commit it to version control.
Make your first request
Use your API key as a Bearer token in the Authorization header for all requests.
curl https://api.cincht.com/v1/auth/me \ -H "Authorization: Bearer YOUR_KEY"
Send a message
Send your first WhatsApp message with a simple POST request.
curl https://api.cincht.com/v1/messages/send \
-H "Authorization: Bearer YOUR_KEY" \
-d '{"to":"+263771234567","text":"Hello!"}'API endpoints
All endpoints are relative to https://api.cincht.com and require HTTPS.
Authentication
Authenticate using Bearer tokens. All endpoints require your secret API key.
- POST/v1/auth/token
- GET/v1/auth/me
Messages
Send WhatsApp messages, templates, and manage conversations.
- POST/v1/messages/send
- POST/v1/messages/template
- GET/v1/conversations
Contacts
Create, update, and segment your contact database.
- GET/v1/contacts
- POST/v1/contacts
- PUT/v1/contacts/:id
Templates
Create and manage Meta-approved WhatsApp message templates.
- GET/v1/templates
- POST/v1/templates
- PUT/v1/templates/:id
Webhooks
Receive real-time events for messages, delivery receipts, and more.
- POST/v1/webhooks
- GET/v1/webhooks
- DELETE/v1/webhooks/:id
Analytics
Retrieve performance data, campaign metrics, and conversation statistics.
- GET/v1/analytics/messages
- GET/v1/analytics/campaigns
- GET/v1/analytics/agents
Code examples
const cincht = require('@cincht/sdk')({
apiKey: process.env.CINCHT_API_KEY
});
const message = await cincht.messages.send({
to: '+263771234567',
text: 'Hello from Cincht! π'
});
console.log(message.id); // msg_abc123const cincht = require('@cincht/sdk')({
apiKey: process.env.CINCHT_API_KEY
});
await cincht.messages.template({
to: '+263771234567',
template: 'order_confirmation',
language: 'en_US',
components: [{
type: 'body',
parameters: [
{ type: 'text', text: '#ORD-9821' },
{ type: 'text', text: '2-3 business days' }
]
}]
});app.post('/webhook/cincht', (req, res) => {
const { event, data } = req.body;
if (event === 'message.received') {
const { from, text } = data;
console.log(`New message from ${from}: ${text}`);
// Trigger your automation here
}
res.sendStatus(200);
});import cincht
client = cincht.Client(api_key="YOUR_KEY")
contacts = client.contacts.list(
segment="vip_customers",
limit=100,
page=1
)
for contact in contacts.data:
print(f"{contact.name}: {contact.phone}")Official SDKs
Use our official SDKs for faster integration. All SDKs are open source and actively maintained.
Fully documented
Every endpoint documented with examples, error codes, and response schemas.
Fast & reliable
99.9% uptime SLA with global CDN and sub-100ms response times.
OpenAPI spec
Download the OpenAPI 3.0 spec to generate clients in any language.
Sandbox mode
Test your integration without sending real messages using our sandbox environment.
Ready to build?
Get your API key and start integrating WhatsApp Business messaging into your product today.