Start Chat

Creates a new chat in LiveChat.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

object

The chat payload to create.

object

Initial chat properties.

object

Initial chat access settings.

array of object

Existing users to include in the chat.

stringrequired

The user ID.

stringrequired

Possible values: agent or customer.

object

The initial chat thread.

array of object

Initial chat events.

object

Initial thread properties.

boolean

Create an active thread by default.

boolean

Start the chat in continuous mode.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/liveChat/0.0.7/actions/start-chat" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "chat.users[].id": "",
  "chat.users[].type": ""
}'

{
  "success": true,
  "data": [
    {
      "chatId": "string",
      "eventIds": [
        "string"
      ],
      "threadId": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.