## Открепить сообщение

`DELETE /v1/chats/messages/:messageId/pin`

Открепляет сообщение: оно пропадает из списка закреплённых сообщений своего чата. Чат определяется по сообщению, `dialogId` не нужен.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `messageId` (path) | number | да | ID закреплённого сообщения, положительное целое — поле `messageId` из [списка закреплённых сообщений](/docs/chats/messages/pins) |

Тело и параметры запроса не принимаются: любое поле тела или параметр запроса отклоняется с `400 INVALID_PARAMS`.

## Примеры

### curl — личный ключ

```bash
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/messages/1001/pin" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/messages/1001/pin" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1001/pin', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success } = await res.json()
console.log('Откреплено:', success)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/1001/pin', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success } = await res.json()
console.log('Откреплено:', success)
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Пустой массив |

## Пример ответа

```json
{
  "success": true,
  "data": []
}
```

## Пример ответа при ошибке

422 — сообщения нет:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "MESSAGE_NOT_FOUND",
    "b24Code": "MESSAGE_NOT_FOUND"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `messageId` не положительное целое, передано поле тела или параметр запроса. Проверяется до обращения к Битрикс24 |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено», код портала — в `error.b24Code` |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код — в `error.b24Code`, например `MESSAGE_NOT_FOUND` — сообщения нет |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения не может откреплять сообщения — см. [права доступа](/docs/access-rights) |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Повторное открепление проходит успешно.** Открепление сообщения, которое не закреплено, возвращает тот же ответ, что и открепление закреплённого. Проверять, закреплено ли сообщение, перед вызовом не нужно.

## Смотрите также

- [Список закреплённых сообщений](/docs/chats/messages/pins)
- [Закрепить сообщение](/docs/chats/messages/pins-create)
- [Число закреплённых сообщений](/docs/chats/messages/pins-count)
- [Сообщения](/docs/chats/messages)