
## Create a chat from a message

`POST /v1/mail/messages/:id/chat`

Creates a group chat from a message. No request body is required — the message identifier is taken from the path.

## Parameters

| Parameter | In | Type | Required | Description |
|----------|---|-----|:-----:|----------|
| `id` | path | integer | yes | Identifier of the message the chat is created from. List: `GET /v1/mail/messages` |

## Examples

### curl — personal key

```bash
curl -X POST \
  -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.com/v1/mail/messages/123/chat
```

### curl — OAuth application

```bash
curl -X POST \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.com/v1/mail/messages/123/chat
```

### JavaScript — personal key

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/mail/messages/123/chat',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  }
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
console.log(`Chat: ${body.data.chatId}, already existed: ${body.data.existing}`)
```

### JavaScript — OAuth application

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/mail/messages/123/chat',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
```

## Response fields

| Field | Type | Description |
|------|-----|----------|
| `success` | boolean | `true` on success |
| `data.success` | boolean | Internal operation success flag |
| `data.chatId` | integer | Chat identifier |
| `data.messageId` | integer | Identifier of the message the chat was created from |
| `data.existing` | boolean | `true` if the chat already existed before this call |

## Response example

```json
{
  "success": true,
  "data": {
    "success": true,
    "chatId": 89,
    "messageId": 123,
    "existing": false
  }
}
```

## Error response example

400 — message not found:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Request object validation failed",
    "validation": [
      {
        "message": "The message was deleted or moved to another folder"
      }
    ]
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | Non-numeric or negative `:id` in the path — message `id must be a positive integer` |
| 400 | `INVALID_PARAMS` | The message was deleted or moved to another folder. The reason is in the `validation` array |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `INVALID_API_KEY` | Invalid or expired key |
| 401 | `KEY_INACTIVE` | Key is deactivated |
| 401 | `KEY_EXPIRED` | Key has expired |
| 401 | `TOKEN_MISSING` | Key is not linked to a Bitrix24 portal |
| 403 | `SCOPE_DENIED` | Key lacks the `mail` scope |
| 422 | `BITRIX_ERROR` | Other Bitrix24 errors |
| 429 | `RATE_LIMITED` | Request limit exceeded |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [Create a task from a message](./task.md)
- [Create an event from a message](./calendar-event.md)
- [Create objects from a message](/docs/mail/conversions)
- [Mail](/docs/mail)
- [Errors](/docs/errors)
