Update Document crm.documentgenerator.document.update
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with "edit" access permission for document generator documents.
The method crm.documentgenerator.document.update updates an existing document.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Document identifier |
|
values |
An object containing the field values of the document. Format:
where:
The list of available fields depends on the template and document. You can view the fields using the method crm.documentgenerator.document.getfields |
|
stampsEnabled |
Include stamp and signature:
Default is |
Method Feature
pdfUrl and imageUrl may be absent immediately after the update, as conversion is performed asynchronously. Check the final status using crm.documentgenerator.document.get
Code Examples
How to Use Examples in Documentation
Example of updating a document where:
- Document
id—61 - New document number —
2026-002 - Stamp inclusion is enabled
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":61,"values":{"DocumentNumber":"2026-002"},"stampsEnabled":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":61,"values":{"DocumentNumber":"2026-002"},"stampsEnabled":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.update
// 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 DocumentUpdateResult = {
document: {
id: string
title: string
number: string
createTime: ISODate
updateTime: ISODate
createdBy: string | null
updatedBy: number | null
changeStampsEnabled: boolean
changeStampsDisabledReason: string
changeQrCodeEnabled: boolean
qrCodeEnabled: boolean
changeQrCodeDisabledReason: string
products: {
currencyId: string
totalSum: string
totalRows: number
}
stampsEnabled: boolean
downloadUrl: string
downloadUrlMachine: string
publicUrl: string | null
isTransformationError: boolean
templateId: string
pullTag: string
emailDiskFile: number
entityTypeId: string
entityId: string
values: Record<string, unknown>
imageUrl: string
pdfUrl: string
}
}
try {
const response = await $b24.actions.v2.call.make<DocumentUpdateResult>({
method: 'crm.documentgenerator.document.update',
params: {
id: 61,
values: {
DocumentNumber: '2026-002',
},
stampsEnabled: 1,
},
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.document.id, result.document.number, result.document.title)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 updateDocument() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.document.update',
params: {
id: 61,
values: {
DocumentNumber: '2026-002',
},
stampsEnabled: 1,
},
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.document.id, result.document.number, result.document.title)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateDocument)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.document.update(
bitrix_id=61,
values={
"DocumentNumber": "2026-002",
},
stamps_enabled=1,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.document.update',
[
'id' => 61,
'values' => [
'DocumentNumber' => '2026-002',
],
'stampsEnabled' => 1,
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating document: ' . $e->getMessage();
}
BX24.callMethod(
'crm.documentgenerator.document.update',
{
id: 61,
values: {
DocumentNumber: '2026-002',
},
stampsEnabled: 1,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.documentgenerator.document.update',
[
'id' => 61,
'values' => [
'DocumentNumber' => '2026-002',
],
'stampsEnabled' => 1,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.documentgenerator.document.update", b24.Params{
"id": 61,
"values": b24.Params{
"DocumentNumber": "2026-002",
},
"stampsEnabled": 1,
})
if err != nil {
return fmt.Errorf("crm.documentgenerator.document.update: %w", err)
}
// The method wraps the response in an object with the "document" key.
raw, ok := b24.Unwrap(res.Result, "document")
if !ok {
return fmt.Errorf("no document key in the response")
}
var item struct {
ChangeStampsEnabled bool `json:"changeStampsEnabled"`
ChangeStampsDisabledReason string `json:"changeStampsDisabledReason"`
ChangeQrCodeEnabled bool `json:"changeQrCodeEnabled"`
QrCodeEnabled bool `json:"qrCodeEnabled"`
ChangeQrCodeDisabledReason string `json:"changeQrCodeDisabledReason"`
DownloadUrl string `json:"downloadUrl"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ChangeStampsEnabled, item.ChangeStampsDisabledReason)
Response Handling
HTTP status: 200
{
"result": {
"document": {
"changeStampsEnabled": false,
"changeStampsDisabledReason": "No seals or signatures in the template",
"changeQrCodeEnabled": false,
"qrCodeEnabled": false,
"changeQrCodeDisabledReason": "No QR code in the template",
"products": {
"currencyId": "UAH",
"totalSum": "0.00",
"totalRows": 0
},
"downloadUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=61",
"publicUrl": null,
"title": "Demonstration implementation of product 2026-001",
"number": "2026-002",
"id": "61",
"createTime": "2026-03-20T14:42:39+03:00",
"createdBy": null,
"updateTime": "2026-03-20T14:42:38+03:00",
"updatedBy": 577,
"stampsEnabled": true,
"isTransformationError": false,
"values": {
"productsTableVariant": "",
"_creationMethod": "rest",
"stampsEnabled": true,
"DocumentNumber": "2026-002"
},
"templateId": "39",
"pullTag": "TRANSFORMDOCUMENT61",
"imageUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getImage&SITE_ID=s1&id=61",
"pdfUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=61",
"emailDiskFile": 5611,
"entityId": "101",
"entityTypeId": "2",
"downloadUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.download.json?..."
}
},
"time": {
"start": 1774006958,
"finish": 1774006960.122164,
"duration": 2.122164011001587,
"processing": 2,
"date_start": "2026-03-20T14:42:38+03:00",
"date_finish": "2026-03-20T14:42:40+03:00",
"operating_reset_at": 1774007558,
"operating": 1.9965031147003174
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Returns the |
|
time |
Information about the request execution time |
Result Type
|
Name |
Description |
|
document |
Data of the updated document. Structure is described in the |
Document Type
|
Name |
Description |
|
Document identifier |
|
|
title |
Document name |
|
number |
Document number |
|
createTime |
Create date |
|
updateTime |
Update date |
|
Identifier of the user who created the document |
|
|
Identifier of the user who updated the document |
|
|
changeStampsEnabled |
Can the stamp and signature inclusion be changed |
|
changeStampsDisabledReason |
Reason why the stamp and signature inclusion cannot be changed |
|
changeQrCodeEnabled |
Can the QR code be enabled or disabled |
|
qrCodeEnabled |
Current state of the QR code |
|
changeQrCodeDisabledReason |
Reason why the QR code cannot be changed |
|
products |
Summary information about the document's products ( |
|
stampsEnabled |
Stamp and signature inclusion flag |
|
downloadUrl |
Link to download the document |
|
downloadUrlMachine |
Link to download the document for machine access |
|
Public link to the document |
|
|
isTransformationError |
Flag indicating a document conversion error |
|
transformationErrorMessage |
Text of the conversion error if |
|
transformationErrorCode |
Code of the conversion error if |
|
Identifier of the template |
|
|
pullTag |
Event tag for document transformation |
|
emailDiskFile |
Identifier of the file in Drive for sending via email |
|
Identifier of the CRM object type |
|
|
Identifier of the CRM object |
|
|
values |
Field values of the document after the update |
|
imageUrl |
Link to the document image, if already created |
|
pdfUrl |
Link to the PDF file of the document, if already created |
Error Handling
HTTP status: 400
{
"error": "DOCGEN_ACCESS_ERROR",
"error_description": "Access denied"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Bitrix\DocumentGenerator\Document constructor must be is public |
Required parameter |
|
|
Access denied |
No access to the document |
|
|
Document not found |
Document with the specified |
|
|
Document not found |
Document does not belong to the CRM module |
|
|
You do not have permissions to modify this document |
Insufficient permissions to modify the document |
|
|
Module documentgenerator is not installed |
The |
|
|
Cant update not saved document |
Attempt to update an unsaved document |
|
|
DOCUMENT_FILE_NOT_PROCESSABLE_ERROR |
Template file is corrupted or has an invalid structure |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a New Document crm.documentgenerator.document.add
- Get Document crm.documentgenerator.document.get
- Get Document Fields crm.documentgenerator.document.getfields
- Get a List of Documents crm.documentgenerator.document.list
- Delete Document crm.documentgenerator.document.delete
- Get crm.documentgenerator.template.getfields Document Template Fields
- How to Add a Template and Create a Document Based on It