Browse the docs

Changelog

What changed in the API and webhooks, newest first. The API address is /api/v1.

v1 - 2026-10

Permissions, idempotency, email and webhooks

  • API keys have permissions. Choose Full access, Read only, Send messages or Custom when you create a key. A key without the permission an endpoint needs gets 403 MISSING_SCOPE. Keys made before this change keep full access.
  • The Idempotency-Key header works on every POST that creates or sends: POST /messages, POST /email/messages, POST /contacts, POST /contacts/bulk and POST /events. A repeat within 24 hours gets the first answer back.
  • New: POST /email/messages sends one email, and GET /email/messages/{id} follows it. POST /email/consent records who agreed to receive email and who asked to stop.
  • Rate limits are 1,200 requests a minute per key, plus 600 sends a minute per key, and a limit for all the keys of a workspace together. Every answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.
  • New: outgoing webhooks. EzReach sends a signed JSON request to your server when a WhatsApp message arrives or changes status, a contact opts out or in, a template is reviewed, an email is delivered, bounced, opened or clicked, an RSVP arrives or a campaign finishes.
  • A secret rotation keeps the previous webhook secret signing for 24 hours, so you can change your server without missing an event.