Quickstart

The BatZap API gives your code the same team inbox your agents use: list conversations, read messages, reply on WhatsApp, tag, assign and resolve chats, and manage groups. It is a JSON REST API served under a single base URL.

https://api.batzap.com/v1

1. Create an API key

• Open the dashboard and go to Settings → API Keys (dashboard.batzap.com).
• Click Create key, give it a name and pick the scopes it needs. Optionally restrict it to specific WhatsApp numbers.
• Copy the key. It is shown only once: BatZap stores just a hash of it.

2. Make your first request

Send the key in the Authorization header, with no Bearer prefix. GET /health is a good smoke test: any valid key can call it.

curl https://api.batzap.com/v1/health \
  -H "Authorization: bzp_live_YOUR_API_KEY"

3. Find your WhatsApp numbers

Most write operations need to know which connected number to act from. List integrations returns each number with its integration_id. If your key is restricted to a single number, that id is filled in for you.

curl https://api.batzap.com/v1/integrations \
  -H "Authorization: bzp_live_YOUR_API_KEY"

4. Send a message

With a key that has the messages:send scope, Send a message delivers a WhatsApp message and records it in the inbox, exactly as if an agent had typed it.