Notes

A text note attached to a single timeline item. Each timeline item can have only one note — saving again overwrites the previous one.

Bitrix24 API: crm.timeline.note.* Scope: crm

Save note

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

Saves a note to a single timeline item. Each timeline item can have only one note — calling again with the same :id overwrites the previous text.

Parameters

Request fields (body)

Examples

curl — personal key

curl -X POST https://vibecode.bitrix24.com/v1/timeline-logs/5012/note \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 2,
    "entityId": 100,
    "text": "The client usually replies within 2 days."
  }'

curl — OAuth application

curl -X POST https://vibecode.bitrix24.com/v1/timeline-logs/5012/note \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 2,
    "entityId": 100,
    "text": "The client usually replies within 2 days."
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/timeline-logs/5012/note', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityTypeId: 2,
    entityId: 100,
    text: 'The client usually replies within 2 days.',
  }),
})

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

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/timeline-logs/5012/note', {
  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,
    text: 'The client usually replies within 2 days.',
  }),
})

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

Response fields

Response example

HTTP 201:

{
  "success": true,
  "data": { "saved": true }
}

Error response example

400 — a required field is missing:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Required body: entityTypeId (positive int), entityId (positive int), text (string). Optional: itemType (default 1)"
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

A single call creates or updates. If the item has no note — one is created; if it does — the text is overwritten. There is no separate update method; a repeat POST with new text is the "update".

Does not validate the existence of the :id log entry. If you pass the id of a nonexistent entry — save still returns 201 + {saved: true}. The note will not actually attach — when you try to read it via GET /:id/note, the response will be 404 ENTITY_NOT_FOUND. Before save, make sure the log entry exists.

itemType: 1 works for log entries and timeline comments. Use itemType: 2 only if you are working with an activity from /v1/activities.

A note and a log entry are different concepts. A log entry is a standalone item in the timeline history (created via POST /v1/timeline-logs). A note is a short comment attached to an item. An item has at most one note.

A note cannot be retrieved without entityTypeId + entityId. Even though a note is tied to a specific itemId, B24 requires the parent entity context when reading and deleting. Keep these parameters from the time of creation.

See also

• Get note
• Delete note
• Create log entry
• Pin entry