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

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

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

#Параметры

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

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

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

#Примеры

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

Terminal
curl -X POST https://vibecode.bitrix24.tech/v1/timeline-logs/5012/unpin \
  -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/unpin \
  -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/unpin', {
  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/unpin', {
  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 Всегда false — подтверждение, что запись больше не закреплена

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

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

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

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 — Ошибки.

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

Идемпотентно. Открепить незакреплённую запись — 200 + {pinned: false}, без ошибки.

Не удаляет запись. Это только снятие выделения, сама лог-запись остаётся в таймлайне. Чтобы убрать из истории — `DELETE /v1/timeline-logs/:id`.

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