Developer docs
Connect your own systems to EzReach. Send WhatsApp messages and emails, keep your contacts in sync, and get a signed message on your server when something happens.
REST API
Every endpoint with its permission, fields, an example request and an example answer.
Webhooks
Signed events sent to your server: replies, delivery receipts, opt-outs, bounces and more.
Quick start
You need a workspace on EzReach. If you do not have one yet, apply for access. Then:
- Create a key. Sign in, open Settings > Developers and choose Manage API keys. Choose Create API key, give it a name and pick its permissions (see below). Only owners and admins can do this.
- Copy the key now. It starts with
wak_and is shown once. Keep it on your server, for example in an environment variable calledEZREACH_API_KEY. Never put it in a web page or a mobile app. - Make your first request. The base address of the API is
https://app.ezreach.in/api/v1.
Your first request
GET /account returns your workspace, your WhatsApp numbers and the key itself. If it works, your key is good.
curl "https://app.ezreach.in/api/v1/account" \
-H "Authorization: Bearer $EZREACH_API_KEY"const res = await fetch("https://app.ezreach.in/api/v1/account", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.EZREACH_API_KEY}`,
},
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);The answer looks like this:
{
"data": {
"workspace": {
"id": "cm4w0rksp4c30001a1b2c3d4e",
"name": "Acme Store",
"timezone": "Asia/Kolkata",
"currency": "USD"
},
"accounts": [
{
"id": "cm4acc0unt0001v7w8x9y0z1a",
"name": "Main number",
"mode": "CLOUD",
"phoneNumber": "+919800000000",
"displayName": "Acme Store",
"status": "CONNECTED",
"isDefault": true
}
],
"apiKey": {
"id": "cm4k3y000001q2w3e4r5t6y7u",
"name": "Backend sync",
"prefix": "wak_3f9A1b2C"
}
}
}Every answer has the same shape. A success is { "data": ... }. A failure is { "error": { "message", "code" } }. See Errors.
Send your first WhatsApp message
Use the id of a WhatsApp number from the answer above, or leave accountId out to use your default number. A template that Meta has approved can be sent at any time. Send an Idempotency-Key with every send, so a retry after a timeout never sends the message twice.
const res = await fetch("https://app.ezreach.in/api/v1/messages", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.EZREACH_API_KEY}`,
"Idempotency-Key": "order-A-1042-confirmation",
"Content-Type": "application/json",
},
body: JSON.stringify({
"to": "+919876543210",
"type": "template",
"template": {
"name": "order_update",
"language": "en_US",
"variables": {
"body": [
"Ananya",
"A-1042",
"shipped"
],
"buttons": [
{
"index": 0,
"subType": "url",
"value": "A-1042"
}
]
}
},
"contact": {
"name": "Ananya Iyer"
}
}),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);The answer holds the message with its id. Delivery happens a moment later: follow it with GET /messages/{id}, or have EzReach tell your server with the message.status webhook.
Where to go next
- Authentication for permissions and presets.
- Idempotency and rate limits before you go live.
- Webhooks to hear about replies, receipts and opt-outs.
- Good practice: consent rules, what transactional email means, and limits per address.

