notif.ml|Documentation
Dashboard →

API Documentation

Everything you need to integrate notif.ml in your application.

Base URL
https://api.notif.ml

Quick example

Send your first message with a single request:

POST/api/send
curl -X POST https://api.notif.ml/api/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+1234567890",
    "channel": "whatsapp",
    "message": "Your order #1234 is ready"
  }'

Request parameters

torequiredstring

Recipient phone number in international format (e.g., +1234567890)

channelrequiredstring

Delivery channel: whatsapp or sms

messagerequiredstring

The text content of your message

mediaUrloptionalstring

URL of an image, video, or document to attach (WhatsApp only)

captionoptionalstring

Caption for media attachments

templateoptionalstring

WhatsApp template name for pre-approved messages

buttonsoptionalarray

Interactive buttons for WhatsApp messages

Examples

Send with media

{
  "to": "+1234567890",
  "channel": "whatsapp",
  "message": "Here's your invoice",
  "mediaUrl": "https://example.com/invoice.pdf",
  "caption": "Invoice #1234"
}

Send with buttons

{
  "to": "+1234567890",
  "channel": "whatsapp",
  "message": "Your order is ready for pickup",
  "buttons": [
    { "type": "reply", "text": "On my way" },
    { "type": "reply", "text": "Reschedule" }
  ]
}

Authentication

Use your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints

POST/send

Send a WhatsApp or SMS message

GET/status/:messageId

Retrieve message status

Looking for advanced features (CRM, campaigns, AI)? Explore SMSV.