Browse the docs

REST API

JSON over https. Every endpoint is listed here with its permission, its fields, an example request and an example answer.

Base address

Base URL
https://app.ezreach.in/api/v1

Send 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.

EndpointPermissionWhat it does
GET/accountaccount:readGet account

Messages

Send template, text and media messages. Delivery happens asynchronously: poll a message to follow it from SENT to DELIVERED and READ.

EndpointPermissionWhat it does
POST/messagesmessages:sendSend a message
GET/messages/{id}messages:readGet message status

Contacts

Keep your WhatsApp audience in sync with your own database. Contacts are identified by phone number within the workspace.

EndpointPermissionWhat it does
GET/contactscontacts:readList contacts
POST/contactscontacts:writeCreate or update a contact
GET/contacts/{phone}contacts:readGet a contact
PATCH/contacts/{phone}contacts:writeUpdate a contact
DELETE/contacts/{phone}contacts:writeDelete a contact
POST/contacts/bulkcontacts:writeBulk upsert contacts

Email

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.

EndpointPermissionWhat it does
POST/email/messagesemail:sendSend an email
GET/email/messages/{id}email:readGet email status

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.

EndpointPermissionWhat it does
POST/email/consentemail:consentRecord email consent

Templates

Read your message templates to know which names, languages and variables you can send.

EndpointPermissionWhat it does
GET/templatestemplates:readList 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.

EndpointPermissionWhat it does
POST/eventsevents:writeReport an event
POST/events/cancelevents:writeCancel a booking or an event
POST/events/rescheduleevents:writeMove a booking or an event
GET/events/{key}events:readLook up a booking