POST /messages
Notifications2 min read

WhatsApp API

Send text, images, videos and documents to your users from your server, check delivery and read conversations, all with one key.

Messages
Text, image, video, audio and documents
Sender
Pick a number, or use the latest
Status
Queued, then sent or failed in seconds
Key
Rotate it any time

Messages from your product

Your shipping service tells the customer their order left. Your booking app reminds them an hour before. Your checkout sends the invoice as a PDF. Each is one request with the recipient and the content. The response is the message, queued, and it becomes sent or failed within seconds.

What you can send

  • Text, up to the length WhatsApp allows.
  • Media from any https link Rimbra can download: image, video, audio or document. The text becomes the caption.
  • From a specific number, by passing its ID, or from your most recently connected number.

Endpoints

EndpointDoes
POST /messagesSend a text or media message
GET /messages/{id}One message and its status
GET /whatsapp/numbersYour numbers and how many they sent today
GET /inbox/threadsConversations and their messages
GET /contactsContact names and opt-outs
GET /usageDaily sent, received and failed
/webhooksManage webhook endpoints

Errors that explain themselves

CodeMeaning
401The key is missing or wrong
422The recipient isn’t on WhatsApp or has opted out
429Your workspace used its monthly allowance. Add more in Billing → Usage

Questions

Where do I get a key?

Activating WhatsApp creates one. It lives in WhatsApp → API, where you can also rotate it. The old key stops working right away.

Can I call the API from a mobile app?

No. Call it from your server so the key stays secret.

Launch it on Rimbra.

Free to start. No card. Your first app is live in about a minute.