Update Existing Document 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:
documentgeneratorWho can execute the method: a user with permission to view documents and to modify this document
The method documentgenerator.document.update updates a document with new field values.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Document identifier. You can obtain the document identifier after creating a document or by using the get document list method |
|
values |
Field values of the document in the format |
|
stampsEnabled |
Stamp and signature mode:
Default is |
|
fields |
Description of how to interpret and format values from The key of the If you are only passing plain text, this parameter can be omitted. Example structure of
|
Parameter fields
|
Name |
Description |
|
TYPE |
Field type. Types for which formatting can be specified:
|
|
FORMAT |
Formatting parameters for the field type.
For For
User Documentation |
|
PROVIDER |
Provider class |
|
TITLE |
Field title |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":51,"values":{"DocumentNumber":"DC-2026-001","CurrentDate":"2026-03-20T00:00:00+02:00","ClientName":"Müller GmbH","ClientPhone":"+49 30 12345678","Total":"130000","Comment":"Payment within 3 business days after signing","UserName":"Klaus Weber"},"stampsEnabled":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":51,"values":{"DocumentNumber":"DC-2026-001","CurrentDate":"2026-03-20T00:00:00+02:00","ClientName":"Müller GmbH","ClientPhone":"+49 30 12345678","Total":"130000","Comment":"Payment within 3 business days after signing","UserName":"Klaus Weber"},"stampsEnabled":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/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
templateId: string
provider: string
value: string
values: Record<string, unknown>
stampsEnabled: boolean
downloadUrl: string
pdfUrl: string
imageUrl: string
printUrl: string
downloadUrlMachine: string
pdfUrlMachine: string
imageUrlMachine: string
printUrlMachine: string
publicUrl: string
publicUrlView: { time: ISODate | null }
isTransformationError: boolean
pullTag: string
emailDiskFile: number
createTime: ISODate | null
updateTime: ISODate | null
createdBy: string
updatedBy: number | null
}
}
try {
const response = await $b24.actions.v2.call.make<DocumentUpdateResult>({
method: 'documentgenerator.document.update',
params: {
id: 51,
values: {
DocumentNumber: 'DG-2026-001',
CurrentDate: '2026-03-20T00:00:00+03:00',
ClientName: 'Romashka LLC',
ClientPhone: '+49 30 12345678',
Total: '130000',
Comment: 'Payment within 3 business days after signing',
UserName: 'Ivan Petrov',
},
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.title, result.document.downloadUrl)
}
} 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: 'documentgenerator.document.update',
params: {
id: 51,
values: {
DocumentNumber: 'DG-2026-001',
CurrentDate: '2026-03-20T00:00:00+03:00',
ClientName: 'Romashka LLC',
ClientPhone: '+49 30 12345678',
Total: '130000',
Comment: 'Payment within 3 business days after signing',
UserName: 'Ivan Petrov',
},
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.title, result.document.downloadUrl)
} 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.documentgenerator.document.update(
bitrix_id=51,
values={
"DocumentNumber": "DG-2026-001",
"CurrentDate": "2026-03-20T00:00:00+03:00",
"ClientName": "Müller GmbH",
"ClientPhone": "+49 30 12345678",
"Total": "130000",
"Comment": "Payment within 3 business days after signing",
"UserName": "Klaus Weber",
},
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(
'documentgenerator.document.update',
[
'id' => 51,
'values' => [
'DocumentNumber' => 'DC-2026-001',
'CurrentDate' => '2026-03-20T00:00:00+02:00',
'ClientName' => 'Müller GmbH',
'ClientPhone' => '+49 30 12345678',
'Total' => '130000',
'Comment' => 'Payment within 3 business days after signing',
'UserName' => 'Klaus Weber',
],
'stampsEnabled' => 1,
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'documentgenerator.document.update',
{
id: 51,
values: {
DocumentNumber: 'DC-2026-001',
CurrentDate: '2026-03-20T00:00:00+02:00',
ClientName: 'Müller GmbH',
ClientPhone: '+49 30 12345678',
Total: '130000',
Comment: 'Payment within 3 business days after signing',
UserName: 'Klaus Weber'
},
stampsEnabled: 1
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'documentgenerator.document.update',
[
'id' => 51,
'values' => [
'DocumentNumber' => 'DC-2026-001',
'CurrentDate' => '2026-03-20T00:00:00+02:00',
'ClientName' => 'Müller GmbH',
'ClientPhone' => '+49 30 12345678',
'Total' => '130000',
'Comment' => 'Payment within 3 business days after signing',
'UserName' => 'Klaus Weber',
],
'stampsEnabled' => 1,
]
);
print_r($result);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "documentgenerator.document.update", b24.Params{
"id": 51,
"values": b24.Params{
"DocumentNumber": "DC-2026-001",
"CurrentDate": "2026-03-20T00:00:00+02:00",
"ClientName": "Müller GmbH",
"ClientPhone": "+49 30 12345678",
"Total": "130000",
"Comment": "Payment within 3 business days after signing",
"UserName": "Klaus Weber",
},
"stampsEnabled": 1,
})
if err != nil {
return fmt.Errorf("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 {
DownloadUrl string `json:"downloadUrl"`
PublicUrl string `json:"publicUrl"`
Title string `json:"title"`
Number string `json:"number"`
ID b24.ID `json:"id"`
CreateTime string `json:"createTime"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.DownloadUrl, item.PublicUrl)
Response Handling
HTTP Status: 200
{
"result": {
"document": {
"downloadUrl": "/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&SITE_ID=s1&id=51&ts=1773844068",
"publicUrl": "https://mysite.com/~bat5R",
"title": "SUPPLY_CONTRACT Template 1773843147554 DC-2026-001",
"number": "DC-2026-001",
"id": "51",
"createTime": "2026-03-19T15:08:20+02:00",
"createdBy": null,
"updateTime": "2026-03-19T15:08:19+02:00",
"updatedBy": 503,
"stampsEnabled": true,
"isTransformationError": false,
"value": "SUPPLY_CONTRACT_2026_015",
"values": {
"productsTableVariant": "",
"_creationMethod": "rest",
"stampsEnabled": true,
"DocumentNumber": "DC-2026-001",
"CurrentDate": "2026-03-20T00:00:00+02:00",
"ClientName": "Müller GmbH",
"ClientPhone": "+49 30 12345678",
"Total": "130000",
"Comment": "Payment within 3 business days after signing",
"UserName": "Klaus Weber"
},
"publicUrlView": {
"time": "2026-03-19T15:08:05+02:00"
},
"templateId": "53",
"provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
"pullTag": "TRANSFORMDOCUMENT51",
"emailDiskFile": 5573,
"downloadUrlMachine": "https://mysite.com/rest/documentgenerator.api.document.getfile.json?auth=1fe8bb690000071b00000844000001f7f0f107826a2f4f01a384d1dcdb624764d8ea63&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlJlNJVEVfSUQ9czEmaWQ9NTEmdHM9MTc3Mzg0NDA2OCZfPVptQjFqSzNTNlhtMm5EbUR6OFV6YlJydExGbGtaOGpF%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlfGRvY3VtZW50Z2VuZXJhdG9yfFlXTjBhVzl1UFdSdlkzVnRaVzUwWjJWdVpYSmhkRzl5TG1Gd2FTNWtiMk4xYldWdWRDNW5aWFJtYVd4bEpsTkpWRVZmU1VROWN6RW1hV1E5TlRFbWRITTlNVGMzTXpnME5EQTJPQ1pmUFZwdFFqRnFTek5UTmxodE1tNUViVVI2T0ZWNllsSnlkRXhHYkd0YU9HcEZ8MWZlOGJiNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc4MjZhMmY0ZjAxYTM4NGQxZGNkYjYyNDc2NGQ4ZWE2MyI%3D.Cifk0KKcqbktmPy6ARfXPn7dO71%2FP4MY5xys1%2FGF%2FBc%3D"
}
},
"time": {
"start": 1773922099,
"finish": 1773922099.372946,
"duration": 0.37294602394104004,
"processing": 0,
"date_start": "2026-03-19T15:08:19+02:00",
"date_finish": "2026-03-19T15:08:19+02:00",
"operating_reset_at": 1773922699,
"operating": 0.13009309768676758
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
document |
Data of the updated document (detailed description) |
Object document
|
Name |
Description |
|
id |
Document identifier. In the documentgenerator.document.add response, it is returned as a number |
|
title |
Document title |
|
number |
Document number |
|
templateId |
Template identifier |
|
provider |
Data provider class |
|
value |
External identifier of the object for which the document was created |
|
values |
Field values of the document (detailed description) |
|
stampsEnabled |
Indicator of enabled stamps and signatures |
|
downloadUrl |
Link to download DOCX |
|
downloadUrlMachine |
Link to download DOCX for the application |
|
pdfUrl |
Link to download PDF. The field is returned only when the PDF has already been generated. Conversion is asynchronous, so the field is usually absent immediately after the document is created or updated |
|
pdfUrlMachine |
Link to download PDF for the application. Returned together with |
|
printUrl |
Link to view or print the PDF. Returned together with |
|
printUrlMachine |
Link to view or print the PDF for the application. Returned together with |
|
imageUrl |
Link to download the document image. The field is returned only when the image has already been generated |
|
imageUrlMachine |
Link to download the image for the application. Returned together with |
|
publicUrl |
Public link to the document. If the link is not enabled, You can enable the link using the documentgenerator.document.enablepublicurl method |
|
publicUrlView |
Data on viewing the public link (detailed description). The field is returned only if the public link is enabled |
|
isTransformationError |
Indicator of an error when converting the document to PDF and image |
|
transformationErrorCode |
Conversion error code. The field is returned only if |
|
transformationErrorMessage |
Conversion error text. The field is returned only if |
|
transformationCancelReason |
Reason the conversion was canceled. The field is returned only if the conversion was canceled |
|
pullTag |
Tag for subscribing to conversion status updates |
|
emailDiskFile |
Identifier of the file on Drive for sending by e-mail: the PDF file if it has been generated, otherwise the DOCX file. If the file is not stored on Drive, |
|
createTime |
Document creation time |
|
createdBy |
Identifier of the document author. In the documentgenerator.document.add response, it is returned as a number. In the documentgenerator.document.update response, it is |
|
updateTime |
Time of the last document modification |
|
updatedBy |
Identifier of the user who last modified the document. If the document has not been modified, |
Object values
|
Name |
Description |
|
productsTableVariant |
Variant of the product table display |
|
_creationMethod |
Method of document creation |
|
stampsEnabled |
Indicator of enabled stamps and signatures |
|
<field_code> |
Value of the field from the template by its code |
Object publicUrlView
|
Name |
Description |
|
time |
Time of the last view of the public link. If the link has not been opened yet, |
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Document was not found."
}
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Document was not found |
Document with the specified |
|
|
|
You do not have permissions to view documents |
No permission to view documents. The method checks this permission first, then the permission to modify the document |
|
|
|
You do not have permissions to modify this document |
The user can view documents but has no permission to modify the document with the specified |
|
|
|
Access denied |
No access to the document with the specified |
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 Based on a Template documentgenerator.document.add
- Get Document by ID documentgenerator.document.get
- Get the List of Documents documentgenerator.document.list
- Delete document documentgenerator.document.delete
- Enable or disable public link for document documentgenerator.document.enablepublicurl
- Get the list of fields for the document documentgenerator.document.getfields