2Chat API Documentation
This is the complete API documentation for connecting to the 2Chat 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 2Chat: Manage WhatsApp channels, contacts, messages, and webhooks. Keep reading to get started.
Quickstart
Before you run your first 2Chat 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 2Chat connection — create or choose one in Connections. Note its
connectionId.
Every 2Chat action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/chat/latest/actions/{actionSlug}You need a MindCloud API Key and a 2Chat connection. Then call an action such as Check If Number Is On WhatsApp:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/chat/latest/actions/check-if-number-is-on-whats-app" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"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.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected 2Chat account that should run the action. MindCloud stores and refreshes the 2Chat credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
2Chat actions
All 25 published actions for this 2Chat version. Each page documents the endpoint, arguments, and response controls.
- PUTAdd Participant
- GETCheck If Number Is On WhatsApp
- POSTCreate Contact
- POSTCreate Group
- POSTCreate WhatsApp QR Connection
- DELETEDelete Contact
- DELETEDelete Message
- PUTExecute Channel Command
- GETGet a Message
- GETGet Account Info
- GETGet Channel Status
- GETGet Contact
- GETGet Messages by Phone Number
- GETGet WhatsApp Number
- GETList All Webhooks
- GETList Contacts
- GETList Conversations
- GETList Group Participants
- GETList Webhooks By Channel
- GETList WhatsApp Groups
- GETList WhatsApp Numbers
- PUTRemove Participant
- GETSearch Contacts
- POSTSend WhatsApp Message
- PUTUpdate Contact
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.