API Reference — WhatsApp Business API

Interactive reference

API & Integration Guide

Explore endpoints and cURL examples, and try requests in the sandbox below.

API Reference

WhatsApp Configuration

Handle WhatsApp account connections and numbers. Call these endpoints first to obtain waba_id and phone numbers. Marketing Messages API (MM Lite) settings control how MARKETING templates are sent.

Authentication

Include your API key on every request using one of these headers.

Recommended first

1Call GET /api/whatsapp/connections to list WABA accounts.
2Call GET /api/whatsapp/phone-numbers for sender numbers.
3Use waba_id and phone numbers in messaging, templates, and campaigns.
4Optional: GET /api/whatsapp/:wabaId/marketing-messages — MM API is enabled by default; MARKETING templates use Meta's optimized send path.

Fetch WABA Connections

GEThttps://prepbot-api.prepseed.com/api/whatsapp/connectionsAPI key required

Request & response

bash

curl -X GET 'https://prepbot-api.prepseed.com/api/whatsapp/connections' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

API Playground

Sandbox — simulated response, no request leaves your browser

Request preview

GET/api/whatsapp/connections

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

Fetch All Phone Numbers

GEThttps://prepbot-api.prepseed.com/api/whatsapp/phone-numbersAPI key required

Request & response

bash

curl -X GET 'https://prepbot-api.prepseed.com/api/whatsapp/phone-numbers' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

API Playground

Sandbox — simulated response, no request leaves your browser

Request preview

GET/api/whatsapp/phone-numbers

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

Fetch WABA-Specific Phone Numbers

GEThttps://prepbot-api.prepseed.com/api/whatsapp/:wabaId/phone-numbersAPI key required

Replace :wabaId with your WABA document ID or Meta business account ID.

Request & response

bash

curl -X GET 'https://prepbot-api.prepseed.com/api/whatsapp/:wabaId/phone-numbers' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

API Playground

Sandbox — simulated response, no request leaves your browser

wabaId*path

Path parameter

Request preview

GET/api/whatsapp/:wabaId/phone-numbers

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

Setup WABA webhooks (Meta)

POSThttps://prepbot-api.prepseed.com/api/whatsapp/:wabaId/webhooks/setupAPI key required

Subscribe Meta webhooks for inbound messages and delivery events. Business API (Cloud API) only — run after connecting WABA.

Request & response

bash

curl -X POST 'https://prepbot-api.prepseed.com/api/whatsapp/:wabaId/webhooks/setup' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

API Playground

Sandbox — simulated response, no request leaves your browser

wabaId*path

Path parameter

Request preview

POST/api/whatsapp/:wabaId/webhooks/setup

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

Sync workspace from Meta

POSThttps://prepbot-api.prepseed.com/api/whatsapp/workspace/syncAPI key required

Refreshes phone numbers from Meta. Also re-syncs Marketing Messages API onboarding status.

Request & response

bash

curl -X POST 'https://prepbot-api.prepseed.com/api/whatsapp/workspace/sync' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

API Playground

Sandbox — simulated response, no request leaves your browser

Request preview

POST/api/whatsapp/workspace/sync

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

Get Marketing Messages API settings

GEThttps://prepbot-api.prepseed.com/api/whatsapp/:wabaId/marketing-messagesAPI key required

Per-WABA settings for Meta Marketing Messages API (MM Lite). MARKETING templates are routed to /marketing_messages when enabled (default).

Request & response

bash

curl -X GET 'https://prepbot-api.prepseed.com/api/whatsapp/:wabaId/marketing-messages' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

API Playground

Sandbox — simulated response, no request leaves your browser

wabaId*path

Path parameter

Request preview

GET/api/whatsapp/:wabaId/marketing-messages

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

Update Marketing Messages API settings

PUThttps://prepbot-api.prepseed.com/api/whatsapp/:wabaId/marketing-messagesAPI key required

product_policy CLOUD_API_FALLBACK sends via Cloud API when the WABA is not yet onboarded to MM API. STRICT fails instead of falling back.

Request & response

bash

curl -X PUT 'https://prepbot-api.prepseed.com/api/whatsapp/:wabaId/marketing-messages' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "enabled": true,
  "product_policy": "CLOUD_API_FALLBACK",
  "activity_sharing": null
}'

API Playground

Sandbox — simulated response, no request leaves your browser

wabaId*path

Path parameter

Request preview

PUT/api/whatsapp/:wabaId/marketing-messages

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

Sync Marketing Messages onboarding status

POSThttps://prepbot-api.prepseed.com/api/whatsapp/:wabaId/marketing-messages/sync-statusAPI key required

Fetches marketing_messages_onboarding_status from Meta. Runs automatically when you connect or sync a WABA.

Request & response

bash

curl -X POST 'https://prepbot-api.prepseed.com/api/whatsapp/:wabaId/marketing-messages/sync-status' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

API Playground

Sandbox — simulated response, no request leaves your browser

wabaId*path

Path parameter

Request preview

POST/api/whatsapp/:wabaId/marketing-messages/sync-status

This sandbox never calls the live API.

Click “Send” to see a simulated response here — nothing is sent over the network.

curl -X PUT 'https://prepbot-api.prepseed.com/api/whatsapp/:wabaId/marketing-messages' \ -H 'X-API-Key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "enabled": true, "product_policy": "CLOUD_API_FALLBACK", "activity_sharing": null }'