#Закрепить запись

POST /v1/timeline-logs/:id/pin

Закрепляет лог-запись в верхней части таймлайна родительской CRM-сущности. Закреплённые записи всегда видны при открытии карточки — менеджеру не нужно скроллить историю, чтобы увидеть важное событие.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID лог-записи (или другого элемента таймлайна)

#Поля запроса (body)

Поле Тип Обяз. Описание
entityTypeId number да Тип родительской CRM-сущности
entityId number да ID родительской записи

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/timeline-logs/5012/pin \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "entityTypeId": 2, "entityId": 100 }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/timeline-logs/5012/pin \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "entityTypeId": 2, "entityId": 100 }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/timeline-logs/5012/pin', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ entityTypeId: 2, entityId: 100 }),
})

const { success } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/timeline-logs/5012/pin', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ entityTypeId: 2, entityId: 100 }),
})

const { success } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.pinned boolean Всегда true — подтверждение, что запись закреплена

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

JSON 
{
  "success": true,
  "data": { "pinned": true }
}

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

400 — пропущены обязательные поля:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Required body: entityTypeId, entityId (positive ints)"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не переданы или некорректны entityTypeId / entityId либо id не положительное целое
404 ENTITY_NOT_FOUND Элемент таймлайна с указанным id не существует
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

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

Закрепление работает не только для лог-записей. Эндпоинт принимает id любого элемента таймлайна — включая комментарии пользователя из `/v1/timelines` и дела (`/v1/activities`). Если знаете id комментария — его тоже можно закрепить через этот эндпоинт.

Повторный pin идемпотентен. Закрепить уже закреплённую запись — операция тоже отдаст 200 + {pinned: true}. Открепить запись — отдельный вызов `POST /unpin`.

Закрепление не зависит от привязок. Если запись привязана к нескольким сущностям через `bind`, pin закрепляет её только в указанной паре entityTypeId+entityId. Чтобы закрепить во всех связанных карточках — отдельные вызовы pin для каждой.

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