# crm.documentgenerator.template.update

URL: https://chugunov.pro/api-bitrix24/crm/document-generator/templates/crm-document-generator-template-update/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Изменить существующий шаблон документа
Scope: `crm`
Кто может выполнять метод: пользователь с правом "изменения" шаблонов генератора документов

## Описание

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

## Параметры

- `id` `integer` — необязательный. Идентификатор шаблона
- `fields` `object` — необязательный. Объект с полями шаблона для обновления [(подробнее)](#fields)

### Параметр fields

- `name` `string` — необязательный. Название шаблона
- `file` `file` — необязательный. Файл шаблона в формате `["имя_файла.docx", "base64_контент"]`. Можно передать в `base64` или в `multipart/form-data`. Подробнее: [Как загружать файлы](https://apidocs.bitrix24.ru/api-reference/files/how-to-upload-files.html)
- `numeratorId` `integer` — необязательный. Идентификатор нумератора. Список доступных нумераторов можно получить методом [crm.documentgenerator.numerator.list](https://chugunov.pro/api-bitrix24/crm/document-generator/numerator/crm-document-generator-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](https://chugunov.pro/api-bitrix24/crm/universal/user-defined-object-types/crm-type-list/) или [crm.enum.ownertype](https://chugunov.pro/api-bitrix24/crm/auxiliary/enum/crm-enum-owner-type/), например:
  - `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` — необязательный. Индекс сортировки

## Ответ

HTTP-статус: 200

```json
{
    "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`](#template)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "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` недоступен

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

### cURL (Webhook)

```bash
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
```

### cURL (OAuth)

```bash
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},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.update
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type UpdateTemplateResult = {
  template: {
    id: string
    name: string
    region: string
    code: string | null
    download: string
    downloadMachine: string
    active: 'Y' | 'N'
    moduleId: string
    numeratorId: string
    withStamps: 'Y' | 'N'
    users: Record<string, string>
    isDeleted: 'Y' | 'N'
    sort: string
    entityTypeId: string[]
    createTime: ISODate
    updateTime: ISODate
  }
}

try {
  const response = await $b24.actions.v2.call.make<UpdateTemplateResult>({
    method: 'crm.documentgenerator.template.update',
    params: {
      id: 41,
      fields: {
        name: 'Template from file (updated)',
        file: ['template-updated.docx', '**base64_encoded_content**'],
        numeratorId: 49,
        region: 'ru',
        entityTypeId: ['2'],
        users: ['UA'],
        active: 'Y',
        withStamps: 'N',
        sort: 500,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.template.id, result.template.name, result.template.updateTime)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateTemplate() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.documentgenerator.template.update',
        params: {
          id: 41,
          fields: {
            name: 'Template from file (updated)',
            file: ['template-updated.docx', '**base64_encoded_content**'],
            numeratorId: 49,
            region: 'ru',
            entityTypeId: ['2'],
            users: ['UA'],
            active: 'Y',
            withStamps: 'N',
            sort: 500,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.template.id, result.template.name, result.template.updateTime)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateTemplate)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.documentgenerator.template.update(
        bitrix_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,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.documentgenerator.template.update',
            [
                '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,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo '<pre>';
    print_r($result);
    echo '</pre>';

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating template: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'crm.documentgenerator.template.update',
    {
        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,
        },
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'crm.documentgenerator.template.update',
    [
        '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,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.template.update", b24.Params{
	"id": 41,
	"fields": b24.Params{
		"name":         "Шаблон из файла (обновлен)",
		"file":         []string{"template-updated.docx", "**base64_encoded_content**"},
		"numeratorId":  49,
		"region":       "ru",
		"entityTypeId": []string{"2"},
		"users":        []string{"UA"},
		"active":       "Y",
		"withStamps":   "N",
		"sort":         500,
	},
})
if err != nil {
	return fmt.Errorf("crm.documentgenerator.template.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "template".
raw, ok := b24.Unwrap(res.Result, "template")
if !ok {
	return fmt.Errorf("в ответе нет ключа template")
}

var item struct {
	ID       b24.ID `json:"id"`
	Name     string `json:"name"`
	Region   string `json:"region"`
	Download string `json:"download"`
	Active   string `json:"active"`
	ModuleID string `json:"moduleId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-update.html