REST API
JSON over https. Every endpoint is listed here with its permission, its fields, an example request and an example answer.
Base address
https://app.ezreach.in/api/v1Send Content-Type: application/json with a body. Send your key as Authorization: Bearer wak_.... Authentication.
Account
Check that your key works and discover the WhatsApp numbers you can send from.
| Endpoint | Permission | What it does | |
|---|---|---|---|
| GET | /account | account:read | Get account |
Messages
Send template, text and media messages. Delivery happens asynchronously: poll a message to follow it from SENT to DELIVERED and READ.
| Endpoint | Permission | What it does | |
|---|---|---|---|
| POST | /messages | messages:send | Send a message |
| GET | /messages/{id} | messages:read | Get message status |
Contacts
Keep your WhatsApp audience in sync with your own database. Contacts are identified by phone number within the workspace.
| Endpoint | Permission | What it does | |
|---|---|---|---|
| GET | /contacts | contacts:read | List contacts |
| POST | /contacts | contacts:write | Create or update a contact |
| GET | /contacts/{phone} | contacts:read | Get a contact |
| PATCH | /contacts/{phone} | contacts:write | Update a contact |
| DELETE | /contacts/{phone} | contacts:write | Delete a contact |
| POST | /contacts/bulk | contacts:write | Bulk upsert contacts |
Send one email at a time from your own system: an order confirmation, a receipt, a password reset, or a marketing email to somebody who agreed to receive it. Every rule of an email campaign applies: your verified From addresses, consent, the suppression list, the footer with your postal address and an unsubscribe link, your daily limit and your wallet.
| Endpoint | Permission | What it does | |
|---|---|---|---|
| POST | /email/messages | email:send | Send an email |
| GET | /email/messages/{id} | email:read | Get email status |
Email consent
Tell the panel who agreed to receive email from your business and who asked to stop. Email consent belongs to the email address and is separate from WhatsApp consent: these calls never change a contact's WhatsApp choice.
| Endpoint | Permission | What it does | |
|---|---|---|---|
| POST | /email/consent | email:consent | Record email consent |
Templates
Read your message templates to know which names, languages and variables you can send.
| Endpoint | Permission | What it does | |
|---|---|---|---|
| GET | /templates | templates:read | List templates |
Events (journeys)
Tell the panel something happened in your system — a booking, a cancellation. Every journey switched on for that event sends its utility templates at the set times. Journeys that are off send nothing, now or later.
| Endpoint | Permission | What it does | |
|---|---|---|---|
| POST | /events | events:write | Report an event |
| POST | /events/cancel | events:write | Cancel a booking or an event |
| POST | /events/reschedule | events:write | Move a booking or an event |
| GET | /events/{key} | events:read | Look up a booking |

