CRM Messaging API Authentication

How to authenticate CRM Messaging API requests: one Bearer API key plus a connectionId. MindCloud stores your API key securely — set it once, never resend it.

Every CRM Messaging API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your CRM Messaging account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a CRM Messaging connection in Connections. CRM Messaging uses an API key. You generate the key in your CRM Messaging account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

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 CRM Messaging account that should run the action. MindCloud stores and refreshes the CRM Messaging 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.

For example, calling List Messages with an CRM Messaging connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/cRMMessaging/actions/list-messages/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which CRM Messaging account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect CRM Messaging with an API token

You need a CRM Messaging account and at least one SMS, WhatsApp, or voice channel configured for the actions you plan to use.

Create or sign in to your CRM Messaging account
Open CRM Messaging and sign in to the account you want to connect in MindCloud.
Set up the channel you want to use
For SMS, connect an SMS phone number in Account Settings and API Configuration. For WhatsApp, go to Integration Gateway, select WhatsApp Integration, and connect your WhatsApp Business phone number. Voice calls require a caller number associated with your account.
Copy your API token
After your channel is connected, open the Developer Console in CRM Messaging and copy the token used in API calls.
Optionally configure webhooks
If you want delivery-status or incoming-message updates, set the delivery and incoming webhook endpoints in the CRM Messaging Developer Console.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.