Superchat API Documentation

This is the complete API documentation for connecting to the Superchat 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 Superchat: Manage contacts, conversations, templates, files, and multichannel messages in Superchat. Keep reading to get started.

Quickstart

Before you run your first Superchat request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Superchat connection — create or choose one in Connections. Note its connectionId.

Every Superchat action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/superchat/latest/actions/{actionSlug}

You need a MindCloud API Key and a Superchat connection. Then call an action such as Get Channel:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/superchat/latest/actions/get-channel" \
  --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 Superchat account that should run the action. MindCloud stores and refreshes the Superchat 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.

Superchat actions

All 40 published actions for this Superchat version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Contact to Contact List
• POSTCreate Contact
• POSTCreate Template
• POSTCreate Template Folder
• POSTCreate Webhook
• DELETEDelete Contact
• DELETEDelete Template
• GETGet Channel
• GETGet Contact
• GETGet Contact List
• GETGet Conversation
• GETGet Current User
• GETGet File
• GETGet Inbox
• GETGet Label
• GETGet Template
• GETGet User
• GETList Channels
• GETList Contact Lists
• GETList Contact Lists for Contact
• GETList Contacts
• GETList Contacts for Contact List
• GETList Conversations
• GETList Conversations for Contact
• GETList Custom Attributes
• GETList Files
• GETList Inboxes
• GETList Labels
• GETList Template Folders
• GETList Templates
• GETList Users
• GETList Webhooks
• GETSearch Contacts
• POSTSend Message
• PUTUpdate Contact
• PUTUpdate Conversation
• PUTUpdate Template
• PUTUpdate Template Folder
• PUTUpdate Webhook
• POSTUpload File

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS