# Start or end live chat

`POST https://api.chat-data.com/api/v2/livechat-state`

Canonical: https://www.chat-data.com/api-reference/toggle-live-chat-state

## Authentication

Send an API key as a Bearer token: `Authorization: Bearer $CHAT_DATA_API_KEY`. Workspace keys reach every chatbot in the workspace; chatbot-scoped keys reach only their chatbot. Keep keys on the server.

## Description

Toggle or set the state of a live chat session for a specific conversation. Your plan must include live chat, and live chat must be enabled in the chatbot's settings.

## Request body (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| chatbotId | string | yes | The unique identifier of the chatbot. |
| conversationId | string | yes | The unique identifier of the conversation. |
| end | boolean | no | If provided, `true` ends the live chat session and `false` reopens it. If omitted, the current state is toggled. |

## Example request

```bash
curl 'https://api.chat-data.com/api/v2/livechat-state' \
  -H "Authorization: Bearer $CHAT_DATA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "chatbotId": "6650f1c2a9e4b83d2c7a1f05",
  "conversationId": "3f2b8c1e-9a4d-4e7b-8c2a-5d1e6f7a8b9c"
}'
```

## Example response (200)

```json
{
  "status": "success",
  "liveChatEnded": true
}
```

## Responses

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | The state could not be changed. For example: `chatbotId` or `conversationId` is missing, the plan does not include live chat, live chat is not enabled for the chatbot, or the conversation does not exist. |
| 401 | Authentication failed: the `Authorization` header is missing or not in the `Bearer <key>` format, the API key does not exist, its workspace is unavailable or has no owner, or the workspace's plan does not include API access. `message` says which. |
| 403 | The API key cannot access the requested chatbot. A chatbot-scoped key used with another chatbot's ID gets `Access denied to this chatbot`. A workspace key gets `Chatbot <id> was not found in this API key's workspace. It may have been deleted or moved to another workspace.` when the chatbot does not exist or belongs to another workspace. |
| 429 | The workspace sent more than 600 API requests in the last minute. Wait the number of seconds given in the `Retry-After` header (and in `message`) before retrying. |