Upload Document crm.documentgenerator.document.upload
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize 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.upload uploads a prepared document and attaches it to a CRM object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with document upload parameters (more details) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the CRM object type. Typical values:
For SPAs, their |
|
entityId* |
Identifier of the CRM object to which the document is attached |
|
fileContent* |
Content of the DOCX file in base64 format. More details: How to upload files |
|
region* |
Template region code, for example, |
|
title* |
Document name |
|
number* |
Document number |
|
pdfContent |
Content of the PDF file in base64 format. More details: How to upload files |
|
imageContent |
Content of the image in base64 format. More details: How to upload files |
Method specifics
pdfUrl and imageUrl may be absent immediately after upload, as conversion is performed asynchronously. To check the result, use crm.documentgenerator.document.get
Code Examples
How to Use Examples in Documentation
Example of uploading a document where:
entityTypeId—2(deal)entityId—101region—ru- document title — Product demonstration
- document number —
2026-001
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"entityTypeId":2,"entityId":101,"fileContent":"**base64_docx_content**","region":"de","title":"Product demonstration","number":"2026-001","pdfContent":"**base64_pdf_content**","imageContent":"**base64_image_content**"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.upload
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"entityTypeId":2,"entityId":101,"fileContent":"**base64_docx_content**","region":"de","title":"Product demonstration","number":"2026-001","pdfContent":"**base64_pdf_content**","imageContent":"**base64_image_content**"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.upload
// 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 DocumentUploadResult = {
document: {
id: string
title: string
number: string
createTime: ISODate
updateTime: ISODate
createdBy: string
updatedBy: string | null
changeStampsEnabled: boolean
changeStampsDisabledReason: string
changeQrCodeEnabled: boolean
qrCodeEnabled: boolean
changeQrCodeDisabledReason: string
products: {
currencyId: string
totalSum: string
totalRows: number
}
stampsEnabled: boolean
isTransformationError: boolean
downloadUrl: string
downloadUrlMachine: string
publicUrl: string | null
templateId: string
pullTag: string
emailDiskFile: number
entityTypeId: string
entityId: string
values: Record<string, unknown> | null
}
}
try {
const response = await $b24.actions.v2.call.make<DocumentUploadResult>({
method: 'crm.documentgenerator.document.upload',
params: {
fields: {
entityTypeId: 2,
entityId: 101,
fileContent: '**base64_docx_content**',
region: 'de',
title: 'Demo Sales Document',
number: '2026-001',
pdfContent: '**base64_pdf_content**',
imageContent: '**base64_image_content**',
},
},
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 uploadDocument() {
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.upload',
params: {
fields: {
entityTypeId: 2,
entityId: 101,
fileContent: '**base64_docx_content**',
region: 'de',
title: 'Demo Sales Document',
number: '2026-001',
pdfContent: '**base64_pdf_content**',
imageContent: '**base64_image_content**',
},
},
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', uploadDocument)
</script>
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.document.upload',
[
'fields' => [
'entityTypeId' => 2,
'entityId' => 101,
'fileContent' => '**base64_docx_content**',
'region' => 'de',
'title' => 'Product demonstration',
'number' => '2026-001',
'pdfContent' => '**base64_pdf_content**',
'imageContent' => '**base64_image_content**',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error uploading document: ' . $e->getMessage();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.document.upload(
fields={
"entityTypeId": 2,
"entityId": 101,
"fileContent": "**base64_docx_content**",
"region": "de",
"title": "Product demonstration",
"number": "2026-001",
"pdfContent": "**base64_pdf_content**",
"imageContent": "**base64_image_content**",
},
).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}")
BX24.callMethod(
'crm.documentgenerator.document.upload',
{
fields: {
entityTypeId: 2,
entityId: 101,
fileContent: '**base64_docx_content**',
region: 'de',
title: 'Product demonstration',
number: '2026-001',
pdfContent: '**base64_pdf_content**',
imageContent: '**base64_image_content**',
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.documentgenerator.document.upload',
[
'fields' => [
'entityTypeId' => 2,
'entityId' => 101,
'fileContent' => '**base64_docx_content**',
'region' => 'de',
'title' => 'Product demonstration',
'number' => '2026-001',
'pdfContent' => '**base64_pdf_content**',
'imageContent' => '**base64_image_content**',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"document": {
"changeStampsEnabled": false,
"changeStampsDisabledReason": "The template is missing seals and signatures",
"changeQrCodeEnabled": false,
"qrCodeEnabled": false,
"changeQrCodeDisabledReason": "The template is missing a QR code",
"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=63",
"publicUrl": null,
"title": "Product demonstration",
"number": "2026-001",
"id": "63",
"createTime": "2026-03-20T17:08:24+03:00",
"createdBy": "577",
"updateTime": "2026-03-20T17:08:24+03:00",
"updatedBy": null,
"stampsEnabled": false,
"isTransformationError": false,
"values": {
"productsTableVariant": "",
"_creationMethod": "rest"
},
"templateId": "55",
"pullTag": "TRANSFORMDOCUMENT63",
"emailDiskFile": 5619,
"entityId": "101",
"entityTypeId": "2",
"downloadUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.download.json?auth=***&token=***"
}
},
"time": {
"start": 1774015704,
"finish": 1774015705.08562,
"duration": 1.0856199264526367,
"processing": 1,
"date_start": "2026-03-20T17:08:24+03:00",
"date_finish": "2026-03-20T17:08:25+03:00",
"operating_reset_at": 1774016304,
"operating": 1.0284008979797363
}
}
Returned Data
|
Name |
Description |
|
result |
Root object of the response. Contains the structure |
|
time |
Information about the request execution time |
Result Type
|
Name |
Description |
|
document |
Data of the uploaded document. Structure described in type |
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 |
|
|
Field values of the document |
|
|
imageUrl |
Link to the document image, if already created |
|
pdfUrl |
Link to the PDF file of the document, if already created |
|
imageUrlMachine |
Link to the document image for machine access |
|
pdfUrlMachine |
Link to the PDF document for machine access |
Error Handling
HTTP status: 400
{
"error": "100",
"error_description": "Invalid value {} to match with parameter {fields}. Should be value of type array."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Could not find value for parameter |
Required parameter |
|
|
Invalid value {} to match with parameter {fields}. Should be value of type array. |
The |
|
|
Empty required fields: entityTypeId, fileContent, region, entityId |
Required fields not provided in |
|
|
Empty required fields: fileContent |
The required field |
|
|
Wrong "entityTypeId" field value |
An invalid |
|
|
No provider for entityTypeId |
No suitable CRM provider found for |
|
|
Wrong "entityId" field value |
An invalid |
|
|
Missing file content |
|
|
|
Could not save file |
Failed to save the uploaded file |
|
|
Module crm is not installed |
The |
|
|
Wrong provider ... |
Incorrect document provider defined |
|
|
Application not found |
Failed to determine the current REST application |
|
|
Error generating file for template |
Failed to create a service file for the hidden template |
|
|
Error getting template |
Failed to get or create a hidden template for upload |
|
Empty value |
You do not have permissions to view documents |
Insufficient permissions to view documents |
|
Empty value |
Module documentgenerator is not installed |
The |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |