BluetickedDeveloper docs
Sign inCreate account

API docs

Everything you need to build on Blueticked: one REST API for WhatsApp, email and SMS.

Make your first request

A test key is all it takes: list your channels, then send a message that creates its contact in the same call.

No template and no connected channel required.

Sign in to try it in the consoleCreate an account for a test key

Building with a coding agent? Hand it the whole API in one fetch.

Works on a brand-new workspace

Request
curl "https://app.blueticked.com/api/v1/channels" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"
Response · application/json
{
  "data": [
    {
      "id": "1891a644-c71d-4a79-b679-6db1db14e065",
      "channel": "sms",
      "display_name": "SMS",
      "identifier": "Blueticked",
      "status": "connected",
      "created_at": "2026-10-12T08:00:00.000Z",
      "sender_id": "Blueticked",
      "uses_default_sender": false,
      "provider": "smsportal"
    }
  ],
  "request_id": "req_091284c4482187a053a615628d3bf435"
}

Guides

Read in order — each one ends by handing you to the next.

  1. 1QuickstartFrom nothing to a delivered message in 6 steps, on a test key until you go live.
  2. 2Test mode and magic numbersBuild the whole integration on a sandbox key: simulated delivery, deterministic failures and test webhooks.
  3. 3Going liveThe whole journey from sandbox to a real customer's first message, including the steps only a human can do.
  4. 4Authentication & limitsHow keys work: bearer auth, scopes, IP allowlisting and rate limits.
  5. 5Rate limits and retriesThe two buckets every request clears, the per-tier ceilings, the rate-limit headers, the 429 and how to back off.
  6. 6Core conceptsPagination, idempotency, test mode and versioning: the four rules that apply to every endpoint.
  7. 7Templates and approvalCreate WhatsApp templates, get them approved by Meta, and use document headers for per-recipient PDFs.
  8. 8Campaigns and statementsBulk WhatsApp sends with a PDF for each recipient: the customer-statement pattern, by API.
  9. 9ContactsCreate, list, fetch and update contacts by API and SDK, including each channel's deliverability flags.
  10. 10ConversationsList conversations, read their messages, and react to inbound replies with the message.received webhook.
  11. 11Suppression and opt-outsManage do-not-contact entries, how STOP suppresses automatically, and how suppression supports POPIA.
  12. 12WebhooksReceive delivery and reply events, and verify that they came from us.
  13. 13Receive events from your appSend your app's events to a connection's callback, read what happened, and retry without sending twice.
  14. 14ErrorsEvery machine-readable error code the API can return, and what to do about each.

Reference

Every endpoint, with examples you can send from the console.

127 endpoints · 29 resources
Browse all endpointsGETPOSTPATCHDELETEChangelogEvery API-visible change · last on 21 Oct 2026

Tools

Ways to build that are not writing HTTP by hand.

TypeScript SDKA typed client from the same OpenAPI document.MCP serverCall the API as tools from any MCP client.Building with AIThe entire contract, one fetch, agent-ready.

Channels

What each channel needs before it will send.

WhatsAppTemplates, the 24-hour service window, and what Meta requires of a business-initiated send.EmailSending identity, HTML bodies, and the compliance footer every marketing send carries.SMSSegments, sender identity and opt-out handling for South African numbers.