метод REST scope: crm

crm.documentgenerator.template.update

Изменить существующий шаблон документа

Кто может выполнять: пользователь с правом "изменения" шаблонов генератора документов

Описание

Метод crm.documentgenerator.template.update обновляет существующий шаблон документа.

Параметры

id integer необязательный

Идентификатор шаблона

fields object необязательный

Объект с полями шаблона для обновления (подробнее)

Параметр fields

name string необязательный

Название шаблона

file file необязательный

Файл шаблона в формате ["имя_файла.docx", "base64_контент"]. Можно передать в base64 или в multipart/form-data. Подробнее: Как загружать файлы

numeratorId integer необязательный

Идентификатор нумератора. Список доступных нумераторов можно получить методом crm.documentgenerator.numerator.list

region string необязательный

Регион шаблона, например ru

entityTypeId array необязательный

Массив идентификаторов CRM-объектов, для которых доступен шаблон.

Типичные значения:
- 1 — лид
- 2 — сделка
- 3 — контакт
- 4 — компания
- 5 — счет (старая версия)
- 7 — коммерческое предложение
- 31 — счет

Для объектов с воронками добавляется суффикс воронки, например:
- 2_category_0 — сделка, воронка 0
- 31_1 — счет, воронка 1

Для смарт-процессов указывается entityTypeId типа из crm.type.list или crm.enum.ownertype, например:
- 177 — элемент смарт-процесса с entityTypeId = 177
- 177_1 — элемент смарт-процесса с воронкой 1

users array необязательный

Массив кодов прав доступа, например ["UA"].

Поддерживаются коды доступа:
- UA — все пользователи
- U<id> — пользователь
- G<id> — группа пользователей
- D<id> — отдел
- DR<id> — отдел с подотделами
- IU<id> — пользователь интранета
- SG<id>, SG<id>_A, SG<id>_E, SG<id>_K — рабочая группа/проект
- SU<id>, SU<id>_M — пользователь соцсети
- CHAT<id> — чат
- AD, AE, AT, ATD, ATE, ATT (и варианты с идентификатором) — роль в структуре
- SND<id>, SNDR<id>, SNT<id>, SNTR<id> — структурные коды подразделений и команд

active char необязательный

Активность шаблона: Y или N

withStamps char необязательный

Подставлять печать и подпись: Y или N

sort integer необязательный

Индекс сортировки

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":41,"fields":{"name":"Шаблон из файла (обновлен)","file":["template-updated.docx","**base64_encoded_content**"],"numeratorId":49,"region":"ru","entityTypeId":["2"],"users":["UA"],"active":"Y","withStamps":"N","sort":500}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.template.update

Ответ

HTTP-статус: 200

{
    "result": {
        "template": {
            "id": "41",
            "name": "Шаблон из файла (обновлен)",
            "region": "ru",
            "code": null,
            "download": "https://mysite.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=41",
            "active": "Y",
            "moduleId": "crm",
            "numeratorId": "49",
            "withStamps": "N",
            "users": {
                "UA": "UA"
            },
            "isDeleted": "N",
            "sort": "500",
            "downloadMachine": "https://mysite.ru/rest/crm.documentgenerator.template.download.json?...",
            "entityTypeId": [
                "2"
            ],
            "createTime": "2026-03-18T15:54:20+03:00",
            "updateTime": "2026-03-18T17:26:29+03:00"
        }
    },
    "time": {
        "start": 1773843989,
        "finish": 1773843989.201709,
        "duration": 0.20170903205871582,
        "processing": 0,
        "date_start": "2026-03-18T17:26:29+03:00",
        "date_finish": "2026-03-18T17:26:29+03:00",
        "operating_reset_at": 1773844589,
        "operating": 0
    }
}

Возвращаемые данные

result object

Корневой элемент ответа. Содержит объект template

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Шаблон не найден"
}
Код Описание Значение
100 Could not find value for parameter {fields} Не передан обязательный параметр fields
100 Invalid value {...} to match with parameter {fields}. Should be value of type array. Параметр fields передан не как объект
0 Шаблон не найден Шаблон с указанным id не найден или недоступен
0 Could not save file Не удалось сохранить файл шаблона
DOCGEN_ACCESS_ERROR Access denied Нет доступа к шаблону
— You do not have permissions to modify templates Недостаточно прав для изменения шаблонов генератора документов
— Module documentgenerator is not installed Модуль documentgenerator недоступен

Что будем искать? Например,Продвижение