bitrix-tools · andrey-zelenin · Feb 5, 2025 · Feb 5, 2025 · Feb 5, 2025
diff --git a/api-reference/crm/timeline/actions/b24-toc.yaml b/api-reference/crm/timeline/actions/b24-toc.yaml
@@ -0,0 +1,9 @@
+title: Действия с записями в таймлайне
+href: index.md
+items:
+  - name: Обзор методов
+    href: index.md
+  - name: Закрепить запись
+    href: crm-timeline-item-pin.md
+  - name: Открепить запись
+    href: crm-timeline-item-unpin.md
diff --git a/api-reference/crm/timeline/actions/crm-timeline-item-pin.md b/api-reference/crm/timeline/actions/crm-timeline-item-pin.md
@@ -0,0 +1,130 @@
+#  Закрепить запись в таймлайне crm.timeline.item.pin
+
+> Scope: [`crm`](../../../scopes/permissions.md)
+>
+> Кто может выполнять метод: `любой пользователь`
+
+Метод закрепляет запись в таймлайне.
+
+## Параметры метода
+
+{% include [Сноска об обязательных параметрах](../../../../_includes/required.md) %}
+
+#|
+|| **Название**
+`тип` | **Описание** ||
+|| **id***
+[`integer`](../../../data-types.md) | Целочисленный идентификатор дела (например, `999`) ||
+|| **ownerTypeId***
+[`integer`](../../data-types.md#object_type) | [Целочисленный идентификатор типа сущности CRM](../../data-types.md#object_type), к которому привязано дело (например, `2` для сделки) ||
+|| **ownerId***
+[`integer`](../../../data-types.md) | Целочисленный идентификатор элемента CRM, к которому привязано дело (например, `10`) ||
+|#
+
+## Примеры кода
+
+{% include [Сноска о примерах](../../../../_includes/examples.md) %}
+
+{% list tabs %}
+
+- cURL (Webhook)
+
+    ```bash
+    curl -X POST \
+    -H "Content-Type: application/json" \
+    -H "Accept: application/json" \
+    -d '{"id": 999, "ownerTypeId": 2, "ownerId": 10}' \
+    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.item.pin
+    ```
+
+- cURL (OAuth)
+
+    ```bash
+    ```
+
+- JS
+
+    ```js
+    BX24.callMethod(
+        "crm.timeline.item.pin",
+        {
+            id: 999,
+            ownerTypeId: 2,
+            ownerId: 10,
+        }, result => {
+            if (result.error())
+                console.error(result.error());
+            else
+                console.dir(result.data());
+        }
+    );
+    ```
+
+- PHP
+
+    ```php
+    ```
+
+{% endlist %}
+
+## Обработка ответа
+
+HTTP-статус: **200**
+
+```json
+{
+    "result": null,
+    "time": {
+        "start": 1712132792.910734,
+        "finish": 1712132793.530359,
+        "duration": 0.6196250915527344,
+        "processing": 0.032338857650756836,
+        "date_start": "2024-04-03T10:26:32+02:00",
+        "date_finish": "2024-04-03T10:26:33+02:00",
+        "operating_reset_at": 1705765533,
+        "operating": 3.3076241016387939
+    }
+}
+```
+
+### Возвращаемые данные
+
+#|
+|| **Название**
+`тип` | **Описание** ||
+|| **result**
+[`null`](../../../data-types.md) | Результат операции. Всегда возвращает `null` ||
+|| **time**
+[`time`](../../../data-types.md) | Информация о времени выполнения запроса ||
+|#
+
+## Обработка ошибок
+
+HTTP-статус: **400**
+
+```json
+{
+    "error": "NOT_FOUND",
+    "error_description": "Not found."
+}
+```
+
+{% include notitle [обработка ошибок](../../../../_includes/error-info.md) %}
+
+### Возможные коды ошибок
+
+#|
+|| **Код** | **Описание** ||
+|| `0` | Только три события можно добавить в избранное ||
+|| `100` | Не переданы обязательные поля ||
+|| `ACCESS_DENIED` | Недостаточно прав для выполнения операции ||
+|| `NOT_FOUND` | Элемент не найден ||
+|| `OWNER_NOT_FOUND` | Владелец элемента не найден ||
+|| `CAN_NOT_CHANGE_PINNED` | Невозможно выполнить операцию ||
+|#
+
+{% include [системные ошибки](../../../../_includes/system-errors.md) %}
+
+## Продолжите изучение
+
+- [{#T}](./crm-timeline-item-unpin.md)
diff --git a/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md b/api-reference/crm/timeline/actions/crm-timeline-item-unpin.md
@@ -0,0 +1,129 @@
+#  Открепить запись в таймлайне crm.timeline.item.unpin
+
+> Scope: [`crm`](../../../scopes/permissions.md)
+>
+> Кто может выполнять метод: `любой пользователь`
+
+Метод открепляет запись в таймлайне.
+
+## Параметры метода
+
+{% include [Сноска об обязательных параметрах](../../../../_includes/required.md) %}
+
+#|
+|| **Название**
+`тип` | **Описание** ||
+|| **id***
+[`integer`](../../../data-types.md) | Целочисленный идентификатор дела (например, `999`) ||
+|| **ownerTypeId***
+[`integer`](../../data-types.md#object_type) | [Целочисленный идентификатор типа сущности CRM](../../data-types.md#object_type), к которому привязано дело (например, `2` для сделки) ||
+|| **ownerId***
+[`integer`](../../../data-types.md) | Целочисленный идентификатор элемента CRM, к которому привязано дело (например, `10`) ||
+|#
+
+## Примеры кода
+
+{% include [Сноска о примерах](../../../../_includes/examples.md) %}
+
+{% list tabs %}
+
+- cURL (Webhook)
+
+    ```bash
+    curl -X POST \
+    -H "Content-Type: application/json" \
+    -H "Accept: application/json" \
+    -d '{"id": 999, "ownerTypeId": 2, "ownerId": 10}' \
+    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.item.unpin
+    ```
+
+- cURL (OAuth)
+
+    ```bash
+    ```
+
+- JS
+
+    ```js
+    BX24.callMethod(
+        "crm.timeline.item.unpin",
+        {
+            id: 999,
+            ownerTypeId: 2,
+            ownerId: 10,
+        }, result => {
+            if (result.error())
+                console.error(result.error());
+            else
+                console.dir(result.data());
+        }
+    );
+    ```
+
+- PHP
+
+    ```php
+    ```
+
+{% endlist %}
+
+## Обработка ответа
+
+HTTP-статус: **200**
+
+```json
+{
+    "result": null,
+    "time": {
+        "start": 1712132792.910734,
+        "finish": 1712132793.530359,
+        "duration": 0.6196250915527344,
+        "processing": 0.032338857650756836,
+        "date_start": "2024-04-03T10:26:32+02:00",
+        "date_finish": "2024-04-03T10:26:33+02:00",
+        "operating_reset_at": 1705765533,
+        "operating": 3.3076241016387939
+    }
+}
+```
+
+### Возвращаемые данные
+
+#|
+|| **Название**
+`тип` | **Описание** ||
+|| **result**
+[`null`](../../../data-types.md) | Результат операции. Всегда возвращает `null` ||
+|| **time**
+[`time`](../../../data-types.md) | Информация о времени выполнения запроса ||
+|#
+
+## Обработка ошибок
+
+HTTP-статус: **400**
+
+```json
+{
+    "error": "NOT_FOUND",
+    "error_description": "Not found."
+}
+```
+
+{% include notitle [обработка ошибок](../../../../_includes/error-info.md) %}
+
+### Возможные коды ошибок
+
+#|
+|| **Код** | **Описание** ||
+|| `100` | Не переданы обязательные поля ||
+|| `ACCESS_DENIED` | Недостаточно прав для выполнения операции ||
+|| `NOT_FOUND` | Элемент не найден ||
+|| `OWNER_NOT_FOUND` | Владелец элемента не найден ||
+|| `CAN_NOT_CHANGE_PINNED` | Невозможно выполнить операцию ||
+|#
+
+{% include [системные ошибки](../../../../_includes/system-errors.md) %}
+
+## Продолжите изучение
+
+- [{#T}](./crm-timeline-item-pin.md)
diff --git a/api-reference/crm/timeline/actions/index.md b/api-reference/crm/timeline/actions/index.md
@@ -0,0 +1,17 @@
+# Обзор методов
+
+> Scope: [`crm`](../../../scopes/permissions.md)
+>
+> Кто может выполнять метод: `любой пользователь`
+
+Чтобы важная запись в таймлайне не потерялась, можно закрепить её вверху таймлайна. В таймлайне можно одновременно закрепить не более трех событий.
+
+#|
+|| **Метод** | **Описание** ||
+|| [crm.timeline.item.pin](./crm-timeline-item-pin.md) | Закрепляет запись в таймлайне ||
+|| [crm.timeline.item.unpin](./crm-timeline-item-unpin.md) | Открепляет запись в таймлайне ||
+|#
+
+## Дополнительно
+
+- [Таймлайн в элементе CRM](https://helpdesk.bitrix24.ru/open/16749348/)
diff --git a/api-reference/crm/timeline/b24-toc.yaml b/api-reference/crm/timeline/b24-toc.yaml
@@ -27,3 +27,7 @@ items:
     include:
       path: layout-blocks/b24-toc.yaml
       mode: link
+  - name: Действия с записями
+    include:
+      path: actions/b24-toc.yaml
+      mode: link
diff --git a/api-reference/crm/timeline/index.md b/api-reference/crm/timeline/index.md
@@ -123,3 +123,11 @@
 || [crm.timeline.icon.*](./logmessage/icons/index.md) | Управляют иконками записей ||
 || [crm.timeline.logo.*](./logmessage/logo/index.md) | Управляют логотипами записей ||
 |#
+
+### Действия с записями в таймлайне
+
+#|
+|| **Метод** | **Описание** ||
+|| [crm.timeline.item.pin](./actions/crm-timeline-item-pin.md) | Закрепляет запись в таймлайне ||
+|| [crm.timeline.item.unpin](./actions/crm-timeline-item-unpin.md) | Открепляет запись в таймлайне ||
+|#