Для AI-агентов: markdown этой страницы — /docs-content/chats/messages/personal-pins-create.md индекс документации — /llms.txt
Закрепить сообщение для себя
POST /v1/chats/messages/:messageId/pin/personal
Добавляет сообщение в личные закрепы текущего пользователя в чате, где это сообщение отправлено.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрmessageId (path) |
Типinteger | Обяз.да | ОписаниеID сообщения из истории сообщений |
Нужен скоуп im. Текущий пользователь определяется по токенам авторизации. Параметры выбора владельца и неизвестные параметры отклоняются.
Тело может отсутствовать либо быть {}. Поля тела и параметры запроса не принимаются. Нужен ключ с правом записи.
Примеры
curl — личный ключ
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { data } = await res.json()
console.log(data)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/messages/845/pin/personal', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
console.log(data)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue |
Полеdata |
Типarray | ОписаниеПустой массив — сообщение закреплено |
Пример ответа
{
"success": true,
"data": []
}
Пример ответа при ошибке
400 — передан неизвестный параметр:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "Query parameter `ownerId` is not accepted by POST /v1/chats/messages/:messageId/pin/personal. It takes no query parameters."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеНекорректный ID, неизвестный или повторный параметр либо поле тела |
| HTTP422 | КодBITRIX_ERROR |
Описаниеerror.b24Code равен MESSAGE_NOT_FOUND — сообщения с таким ID нет |
| HTTP422 | КодBITRIX_ERROR |
Описаниеerror.b24Code равен MESSAGE_IS_ALREADY_PERSONAL_PIN — сообщение уже в личных закрепах |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан API-ключ |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеНет настроенных токенов Битрикс24 |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеУ ключа нет скоупа im |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ОписаниеУ текущего пользователя нет доступа |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлючу запрещено менять данные Битрикс24 |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеЗапись не найдена |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 отклонил операцию с другим кодом, он — в error.b24Code |
Общие ошибки API — Ошибки.