Public API reference

Notifyr API documentation

A single REST API for email broadcasts, transactional email, SMS and WhatsApp Business messaging. p95 latency under 200 ms, HMAC webhooks, scoped API keys and idempotency built in.

Get an API key View pricing

Base URL: api.notifyr.in
Auth: x-api-key header
Rate limit: 10k req/s
Latency (p95): < 200 ms

Ready to send your first request?

Create a free Notifyr account, generate a scoped API key and start sending in under 5 minutes.

Get an API key View pricing

API Reference

Use the Notifyr REST API to send emails, SMS and WhatsApp messages and track delivery status.

Base URL

https://api.notifyr.in

Authentication

All API requests require an API key passed in the x-api-key header.

curl -H "x-api-key: bm_live_your_key_here" https://api.notifyr.in/api/v1/templates

Security: Never expose your API key in client-side code. Always call the API from your backend server.

Test vs Production Keys

Keys are prefixed with bm_test_ or bm_live_.

Production keys can send to any recipient and consume prepaid credits on each successful send.
Test keys (bm_test_) are free — no credits deducted — but only deliver to allowed recipients configured in API Keys (max 5 per channel).

API Scopes

API keys are scoped to specific permissions. Ensure your key has the required scope for each endpoint.

email:sendSend emails and manage email broadcasts

whatsapp:sendSend WhatsApp messages and manage WhatsApp broadcasts

logs:readRead logs, broadcast status, and delivery tracking

templates:readList and view email and WhatsApp templates

providers:readView provider status and health

Error Responses

All errors follow a consistent format:

{
  "statusCode": 400,
  "message": "subject is required when using raw html",
  "error": "Bad Request"
}

Code	Meaning
400	Bad Request — Invalid parameters
401	Unauthorized — Invalid or missing API key
403	Forbidden — Key lacks required scope
500	Internal server error

Start sending in 5 minutes

Create a free Notifyr account, verify your sender domain, generate an API key and send your first email. Get bonus credits on signup.

Start free Developer platform