---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://yandex.ru/dev/messenger/doc/ru/api-requests/message-pin.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/messenger/doc/ru/llms.txt

# Закрепление сообщения

Метод позволяет закрепить сообщение в чате.

HTTP метод: `POST`

URL: `https://botapi.messenger.yandex.net/bot/v1/messages/pin/`

## Заголовки
```
Authorization: OAuth <токен>
Content-Type: application/json
```

## Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
| ------------- | ------------ | --- | ---------| ---------------------------------- |
| `chat_id` | Нет* | `string` | Идентификатор целевого чата | Бот должен быть участником чата |
| `login` | Нет* | `string` | Логин целевого пользователя | — |
| `user_id` | Нет* | `string` | Идентификатор целевого пользователя (UUID) | — |
| `message_id` | Да | `integer` | ID сообщения, которое нужно закрепить | Сообщение должно быть из того же чата |
| `thread_id` | Нет | `integer` | Идентификатор треда (timestamp сообщения) | — |

(*) Необходимо указать ровно один из параметров `chat_id`, `user_id` или `login` — в одном запросе нельзя передавать несколько из них одновременно.

## Ограничения {#restriction}
1. Бот может закреплять сообщения только в тех чатах, в которых он является участником или админом.
2. Бот не может закреплять сообщения в чатах, где это отключено настройками чата.

## Результат {#result}
Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация о закреплённом сообщении.

| Имя параметра | Обязательный | Тип | Описание |
| ------------- | ------------ | --- | ---------|
| `ok` | Да | `boolean` | Флаг успешности выполнения |
| `message_id` | Да | `integer` | ID закреплённого сообщения |
| `chat` | Нет | ##[Chat](../data-types.md#chat)## | Информация о чате, в котором закреплено сообщение |

В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле `description`.

| Имя параметра | Обязательный | Тип | Описание |
| ------------- | ------------ | --- | ---------|
| `ok` | Да | `boolean` | Флаг успешности выполнения |
| `description` | Да | `string` | Описание ошибки |

## Пример запроса
```
curl -X POST -H 'Authorization: OAuth AtXXXXXXXXXXX' -H "Content-Type: application/json" -d '{"chat_id":"0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9", "message_id": 1695644763694005}' 'https://botapi.messenger.yandex.net/bot/v1/messages/pin/'
```

## Пример успешного ответа
```
{"ok": true, "message_id": 1695644763694005, "chat": {"type": "group", "id": "0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9"}}
```

## Пример ответа с ошибкой
```
{"ok": false, "description": "Bot is not a member of the chat"}
```