Добавить комментарий

POST /v1/timelines

Создаёт новый комментарий таймлайна, привязанный к записи CRM. Используется для фиксации заметок по сделкам, лидам, контактам и компаниям.

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

Поле Тип Обяз. Описание
entityType string да Тип родительской записи CRM: deal, lead, contact, company или DYNAMIC_<entityTypeId> для смарт-процессов (например, DYNAMIC_174 для смарт-процесса с entityTypeId: 174 из `GET /v1/smart-processes`)
entityId number да ID родительской записи. Источник зависит от типа: GET /v1/deals, GET /v1/leads, GET /v1/contacts, GET /v1/companies, GET /v1/items/:entityTypeId (элементы смарт-процессов)
comment string да Текст комментария. Пустая строка отклоняется ошибкой BITRIX_ERROR Empty comment message
FILES array нет Вложения к комментарию. Каждый элемент — массив из двух строк [имяФайла, base64Содержимое]. Тип поля в схеме Битрикс24 — attached_diskfile

При создании через API автор (authorId) проставляется по владельцу API-ключа, дата создания (createdAt) — сервером.

Прикрепление файлов. Поле FILES — массив пар [имяФайла, base64Содержимое], по одной паре на файл. Содержимое файла передаётся как строка в кодировке base64, файл загружается на Диск Битрикс24 и привязывается к комментарию.

При чтении комментария (`GET /v1/timelines/:id`) прикреплённые файлы возвращаются в поле FILES — объект, где ключ это ID файла на Диске, а значение содержит метаданные:

JSON 
"FILES": {
  "9317": {
    "id": 9317,
    "name": "report.pdf",
    "size": 11,
    "type": "file",
    "urlDownload": "https://vibecode.bitrix24.tech/disk/downloadFile/9317/?filename=report.pdf"
  }
}

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/timelines \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "deal",
    "entityId": 741,
    "comment": "Первый контакт: клиент заинтересовался предложением"
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/timelines \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "deal",
    "entityId": 741,
    "comment": "Первый контакт: клиент заинтересовался предложением"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/timelines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityType: 'deal',
    entityId: 741,
    comment: 'Первый контакт: клиент заинтересовался предложением',
  }),
})

const { success, data } = await res.json()
console.log('Comment ID:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/timelines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityType: 'deal',
    entityId: 741,
    comment: 'Первый контакт: клиент заинтересовался предложением',
  }),
})

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

curl — комментарий с файлом

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/timelines \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "deal",
    "entityId": 741,
    "comment": "Отчёт во вложении",
    "FILES": [["report.pdf", "JVBERi0xLjQKJ..."]]
  }'

Поля ответа

Поле Тип Описание
id number ID созданного комментария
entityType string Тип родительской записи
entityId number ID родительской записи
comment string Текст комментария
authorId number ID автора — при создании через API соответствует владельцу ключа
createdAt datetime Дата создания (ISO 8601, UTC)
FILES object Прикреплённые файлы — только если были переданы. Ключ — ID файла на Диске, значение — метаданные: name, size, type, urlDownload

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

JSON 
{
  "success": true,
  "data": {
    "id": 66303,
    "entityId": 741,
    "entityType": "deal",
    "comment": "Первый контакт: клиент заинтересовался предложением",
    "authorId": 1,
    "createdAt": "2026-04-24T12:34:05.000Z"
  }
}

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

422 — не передан обязательный comment:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Empty comment message"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_FILES_SHAPE Поле FILES передано не массивом пар [[имяФайла, base64Содержимое]]
422 BITRIX_ERROR Нарушение требований: пустой comment, неверный entityType
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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