WhatsBox API Documentation
This is the complete API documentation for connecting to the WhatsBox API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet WhatsBox: Manage WhatsApp conversations, broadcasts, templates, contacts, and webhooks. Keep reading to get started.
Quickstart
Before you run your first WhatsBox request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one WhatsBox connection — create or choose one in Connections. Note its
connectionId.
Every WhatsBox action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/whatsBox/actions/{actionSlug}/runYou need a MindCloud API Key and a WhatsBox connection. Then call an action such as Get My Organization:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/whatsBox/actions/get-my-organization/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your WhatsBox account. See WhatsBox API Authentication for the full flow and how to get your connection credentials.
WhatsBox actions
All 18 published actions for this WhatsBox version. Each page documents the endpoint, arguments, and response controls.
- GETCheck Service Health
- POSTCreate Contact List
- DELETEDelete Contact List
- DELETEDelete Webhook Subscription
- GETGet Contact List
- GETGet My Organization
- GETGet Template
- GETGet Webhook Subscription
- GETList Channels
- GETList Contact Lists
- GETList Team Members
- GETList Templates
- GETList Webhook Subscriptions
- POSTSend Media Message
- POSTSend Template Message
- POSTSend Text Message
- PUTUpdate Contact List
- POSTUpsert Webhook Subscription
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.