Smart Sender API Documentation
This is the complete API documentation for connecting to the Smart Sender 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 Smart Sender: Manage chats, contacts, channels, messages, variables, funnels, tags, and products in Smart Sender. Keep reading to get started.
Quickstart
Before you run your first Smart Sender 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 Smart Sender connection — create or choose one in Connections. Note its
connectionId.
Every Smart Sender action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/smartSender/actions/{actionSlug}/runYou need a MindCloud API Key and a Smart Sender connection. Then call an action such as List Contacts:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/smartSender/actions/list-contacts/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 Smart Sender account. See Smart Sender API Authentication for the full flow and how to get your connection credentials.
Smart Sender actions
All 35 published actions for this Smart Sender version. Each page documents the endpoint, arguments, and response controls.
- POSTAdd Contact Funnel
- POSTAdd Contact Tag
- PUTAssign Chat
- PUTClose Chat
- POSTCreate Channel Gate
- POSTCreate Product
- POSTCreate Variable
- DELETEDelete Product
- DELETEDelete Variable
- POSTFire Contact Event
- GETGet Channel
- GETGet Chat
- GETGet Contact
- GETGet Contact Chat
- GETGet Contact Gates
- GETGet Contact Info
- GETList Channels
- GETList Chat Messages
- GETList Chats
- GETList Contact Funnels
- GETList Contact Messages
- GETList Contact Tags
- GETList Contacts
- GETList Products
- GETList Variables
- PUTMark Chat Read
- PUTMerge Contacts
- DELETERemove Contact Funnel
- DELETERemove Contact Tag
- GETSearch Contacts
- POSTSend Message
- PUTUpdate Channel
- PUTUpdate Contact
- PUTUpdate Product
- PUTUpdate Variable
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.