MindMe API Documentation
This is the complete API documentation for connecting to the MindMe 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 MindMe: MindMe mobile marketing and account platform integration scaffold. Keep reading to get started.
Quickstart
Before you run your first MindMe 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 MindMe connection — create or choose one in Connections. Note its
connectionId.
Every MindMe action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/mindMe/actions/{actionSlug}/runYou need a MindCloud API Key and a MindMe connection. Then call an action such as Get Access Token:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/mindMe/actions/get-access-token/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 MindMe account. See MindMe API Authentication for the full flow and how to get your connection credentials.
MindMe actions
All 40 published actions for this MindMe version. Each page documents the endpoint, arguments, and response controls.
- PUTAdd Contacts To Sequence
- POSTCreate Automation
- POSTCreate Campaign
- POSTCreate Contact
- POSTCreate Contact List
- POSTCreate Contact Note
- POSTCreate CRM Appointment
- POSTCreate CRM Task
- POSTCreate Custom Field
- POSTCreate Deal
- POSTCreate Or Transfer Conversation
- POSTCreate Smart List
- POSTCreate Tag
- DELETEDelete Contact
- GETGet Access Token
- GETGet Campaign
- GETGet Contact
- GETList Automations
- GETList Campaigns
- GETList Contact Lists
- GETList Contact Notes
- GETList Contacts
- GETList Contacts By List
- GETList Conversation Messages
- GETList Conversations
- GETList CRM Calendar Activities
- GETList CRM Tasks
- GETList Custom Fields
- GETList Deals
- GETList Inboxes
- GETList Media Files
- GETList Tags
- GETList Time Zones
- POSTSend Conversation Message
- PUTUpdate Automation Status
- PUTUpdate Campaign Routes
- PUTUpdate Campaign Schedule
- PUTUpdate Contact
- PUTUpdate Contact Categories
- POSTUpload Media File
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.