Developer Platform

Build with BizAI

A clean, modern REST API for sending WhatsApp messages, managing templates, downloading media and tracking delivery — built for SaaS partners delivering WhatsApp-powered customer experiences.

View interactive reference Download OpenAPI spec

REST + JSON

OpenAPI 3.0 spec, predictable schemas, every response is JSON.

API key auth

Pass x-api-key — no OAuth dance required.

Try it live

Every endpoint has request/response examples and copy-paste curl below.

What you can build

Six endpoints + one webhook cover the full lifecycle of WhatsApp Business messaging: outbound send, inbound media, delivery tracking, template management and live usage.

Send WhatsApp messages

Template, text, image, video, document or audio. Phone-number validation, 24-hour service-window awareness and credit deduction all handled server-side.

POST /api/v1/messages/send

Receive delivery + read receipts

Webhook fires for every status change Meta reports — sent, delivered, read, failed. Each event includes the meta_message_id you got back at send time so reconciliation is trivial.

Webhook

Download inbound media

When a user sends you an image, video, audio, document or sticker, fetch the binary in a single GET. We handle Meta's two-step media-id → signed-URL → bytes exchange for you.

GET /api/v1/messages/{id}/media

Manage approved templates

List templates with current Meta status (approved, pending, rejected) and category. Sync from Meta on demand so your portal never lies about what's sendable.

GET /api/v1/templates

Check message status

Look up the delivery status of a specific message by internal UUID or Meta wamid. Useful for retry logic and dashboard timelines.

GET /api/v1/messages/{id}/status

Track usage + bundle credit

Live counts of marketing/utility/authentication sends, credit consumed, credit remaining and bundle expiry. Show your customers their own utilisation in real time.

GET /api/v1/usage

Quick start

From zero to delivered message in three steps. Average time-to-first-send: under five minutes.

1
Get an API key
Contact us to be provisioned as an API partner. We'll set up your tenant, connect your WhatsApp Business Account and issue your API key.
2
Submit your templates
Create your WhatsApp message templates in the BizAI portal. Meta typically approves within 24–48 hours; once approved you can send.
3
Send your first message
Hit POST /api/v1/messages/send with the template name and variables. Use the snippet on the right.

Don't have a key yet?

Email hello@bizai.co.za or book a demo — we'll get you set up.

Send a template message

curl -X POST https://bizaicrm.co.za/api/v1/messages/send \
  -H "x-api-key: $BIZAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+27821234567",
    "type": "template",
    "template_name": "appointment_reminder",
    "variables": ["John", "14:30", "2026-05-20"]
  }'

Response (200 OK)

{
  "success": true,
  "data": {
    "message_id": "9983d3eb-0e9d-4e17-8c69-9906a73b3845",
    "meta_message_id": "wamid.HBgL...",
    "status": "sent"
  }
}

API reference

Every endpoint with its request schema, response schema, error codes, and a copy-paste curl example. Updated automatically as the API evolves.

Base URL: https://www.bizaicrm.co.za · OpenAPI 3.0 · Download spec (.yaml)

Ready to build?

Tell us about your product and we'll have you sending WhatsApp messages within a working day. No long sales cycle — most partners are live in under a week.

Book a demo hello@bizai.co.za