Для AI-агентов: markdown этой страницы — /docs-content/timeline-logs/notes/delete.md индекс документации — /llms.txt

Удалить заметку

DELETE /v1/timeline-logs/:id/note

Удаляет заметку, прикреплённую к элементу таймлайна. Параметры передаются в query string, не в теле запроса.

Параметры

Параметр Тип Обяз. По умолч. Описание
id (path) number да — ID элемента таймлайна. Лог-записи: GET /v1/timeline-logs, дела при itemType равном 2: GET /v1/activities
entityTypeId (query) number да — Тип родительской CRM-сущности. См. Типы сущностей
entityId (query) number да — ID родительской записи. Где взять ID для каждого типа — Типы сущностей
itemType (query) number нет 1 1 — запись истории, 2 — дело

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100',
  {
    method: 'DELETE',
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  },
)

const { success, data } = await res.json()
if (success) console.log('Заметка удалена')

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/timeline-logs/5012/note?entityTypeId=2&entityId=100',
  {
    method: 'DELETE',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
)

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.deleted boolean Всегда true — подтверждение операции

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

HTTP 200:

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

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

400 — параметры переданы в body вместо query:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Required query: entityTypeId, entityId (positive ints). Optional: itemType (default 1)"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Параметры не переданы, переданы некорректно или передан body вместо query
422 BITRIX_ERROR Битрикс24 отклонил запрос
403 SCOPE_DENIED API-ключ не имеет скоупа crm
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Не путать с DELETE /v1/timeline-logs/:id. Там удаляется лог-запись целиком, параметров нет вообще. Здесь — удаление только заметки у элемента, нужны entityTypeId + entityId.

Ответ не говорит, была ли заметка. Повторное удаление уже удалённой заметки и удаление по несуществующему id тоже возвращают 200 и { "deleted": true }. Чтобы узнать, есть ли заметка, прочитайте её через GET /v1/timeline-logs/:id/note: при её отсутствии он отвечает 404.

Удалить заметку может любой ключ со скоупом crm в режиме чтения и записи, независимо от того, кто её создал. У DELETE /v1/timeline-logs/:id иначе: там работает только тот OAuth-ключ, который создал лог-запись.

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