CloudContactAI API Documentation

This is the complete API documentation for connecting to the CloudContactAI 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 CloudContactAI: CloudContactAI lets you manage clients, contacts, campaigns, collection settings, and SMS messaging with bearer-token authentication. Keep reading to get started.

Quickstart

Before you run your first CloudContactAI 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 CloudContactAI connection — create or choose one in Connections. Note its connectionId.

Every CloudContactAI action uses the same URL pattern:

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

You need a MindCloud API Key and a CloudContactAI connection. Then call an action such as Get Campaign Contact Message:

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

CloudContactAI actions

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

• POSTBatch Create Contacts
• POSTCreate Campaign
• POSTCreate Client
• POSTCreate Client Campaign
• POSTCreate Collection Campaign
• POSTCreate Contact
• POSTCreate Direct Campaign
• DELETEDelete Campaign by ID
• DELETEDelete Client by ID
• DELETEDelete Contact by ID
• GETGet Campaign Contact Message
• GETGet Campaign Message Stats
• GETGet Client by ID
• GETGet Collection Client Settings
• GETGet Collection Debtor by Track ID
• GETGet Contact by ID
• GETGet Contact Call Record
• GETGet Message by ID
• GETList Campaigns
• GETList Client Campaigns
• GETList Clients
• GETList Contacts
• GETList Contacts with Email
• GETList Contacts with Phone
• GETList Contacts without Call Record
• GETList Incoming Messages
• GETList Messages by Campaign
• GETList Messages by Contact
• GETList Sent Messages
• PUTPatch Client by ID
• PUTRequeue Campaign
• POSTSend Campaign Messages
• POSTSend Contact Message
• PUTUpdate Client by ID
• PUTUpdate Client Campaign
• PUTUpdate Collection Client Settings
• PUTUpdate Contact by ID

Related apps

More Sales & CRM apps on the Universal API, behind the same REST shape. Or browse all apps.

HubSpotPipedriveGoogle TasksGoogle ContactsTodoistZoho CRMFollow Up BossClose