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: crm

Who 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 entity.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields^* `object`	Object with document upload parameters (more details)

Parameter fields

Required parameters are marked with *

Name `type`	Description
entityTypeId^* `integer`	Identifier of the CRM entity type. Typical values: `1` — lead `2` — deal `3` — contact `4` — company `7` — estimate For SPAs, their `entityTypeId` is passed, for example, `177`
entityId^* `integer`	Identifier of the CRM entity to which the document is attached
fileContent^* `string`	Content of the DOCX file in base64 format. More details: How to upload files
region^* `string`	Template region code, for example, `de`
title^* `string`	Document title
number^* `string`	Document number
pdfContent `string`	Content of the PDF file in base64 format. More details: How to upload files
imageContent `string`	Content of the image in base64 format. More details: How to upload files

Method Features

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 — 101
region — de
document title — Product Demonstration Implementation
document number — 2026-001

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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 Implementation","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 Implementation","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

try
        {
            const response = await $b24.callMethod(
                'crm.documentgenerator.document.upload',
                {
                    fields: {
                        entityTypeId: 2,
                        entityId: 101,
                        fileContent: '**base64_docx_content**',
                        region: 'de',
                        title: 'Product Demonstration Implementation',
                        number: '2026-001',
                        pdfContent: '**base64_pdf_content**',
                        imageContent: '**base64_image_content**',
                    },
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.upload',
                    [
                        'fields' => [
                            'entityTypeId' => 2,
                            'entityId' => 101,
                            'fileContent' => '**base64_docx_content**',
                            'region' => 'de',
                            'title' => 'Product Demonstration Implementation',
                            '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();
        }

BX24.callMethod(
            'crm.documentgenerator.document.upload',
            {
                fields: {
                    entityTypeId: 2,
                    entityId: 101,
                    fileContent: '**base64_docx_content**',
                    region: 'de',
                    title: 'Product Demonstration Implementation',
                    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 Implementation',
                    '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 does not have seals and signatures",
                    "changeQrCodeEnabled": false,
                    "qrCodeEnabled": false,
                    "changeQrCodeDisabledReason": "The template does not have a QR code",
                    "products": {
                        "currencyId": "EUR",
                        "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 Implementation",
                    "number": "2026-001",
                    "id": "63",
                    "createTime": "2026-03-20T17:08:24+01:00",
                    "createdBy": "577",
                    "updateTime": "2026-03-20T17:08:24+01: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+01:00",
                "date_finish": "2026-03-20T17:08:25+01:00",
                "operating_reset_at": 1774016304,
                "operating": 1.0284008979797363
            }
        }

Returned Data

Name `type`	Description
result `object`	Root object of the response. Contains the structure `result`
time `time`	Information about the request execution time

Type result

Name `type`	Description
document `object`	Data of the uploaded document. Structure described in type `document`

Type document

Name `type`	Description
id `integer` \| `string`	Document identifier
title `string`	Document title
number `string`	Document number
createTime `datetime`	Creation date
updateTime `datetime`	Update date
createdBy `integer` \| `string`	Identifier of the user who created the document
updatedBy `integer` \| `string` \| `null`	Identifier of the user who updated the document
changeStampsEnabled `boolean`	Whether the seal and signature substitution feature can be changed
changeStampsDisabledReason `string`	Reason why the seal and signature substitution feature cannot be changed
changeQrCodeEnabled `boolean`	Whether the QR code can be enabled or disabled
qrCodeEnabled `boolean`	Current state of the QR code
changeQrCodeDisabledReason `string`	Reason why the QR code cannot be changed
products `object`	Summary information about the document's products (`currencyId`, `totalSum`, `totalRows`)
stampsEnabled `boolean`	Seal and signature substitution feature indicator
downloadUrl `string`	Link to download the document
downloadUrlMachine `string`	Link to download the document for machine access
publicUrl `string` \| `null`	Public link to the document
isTransformationError `boolean`	Indicator of document conversion error
transformationErrorMessage `string`	Text of the conversion error, if `isTransformationError = true`
transformationErrorCode `string`	Code of the conversion error, if `isTransformationError = true`
templateId `integer` \| `string`	Identifier of the template
pullTag `string`	Tag of the document transformation event
emailDiskFile `integer`	Identifier of the file in Drive for sending via email
entityTypeId `integer` \| `string`	Identifier of the CRM entity type
entityId `integer` \| `string`	Identifier of the CRM entity
values `object` \| `null`	Values of the document fields
imageUrl `string`	Link to the document image, if already created
pdfUrl `string`	Link to the PDF file of the document, if already created
imageUrlMachine `string`	Link to the document image for machine access
pdfUrlMachine `string`	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 `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`100`	Could not find value for parameter	Required parameter `fields` not provided
`100`	Invalid value {} to match with parameter {fields}. Should be value of type array.	Parameter `fields` not passed in object format
`0`	Empty required fields: entityTypeId, fileContent, region, entityId	Required fields in `fields` not provided
`0`	Empty required fields: fileContent	Required field `fields.fileContent` not provided
`0`	Wrong "entityTypeId" field value	Incorrect `fields.entityTypeId` provided
`0`	No provider for entityTypeId	No suitable CRM provider found for `fields.entityTypeId`
`0`	Wrong "entityId" field value	Incorrect `fields.entityId` provided
`0`	Missing file content	`fields.fileContent` not provided or unreadable
`0`	Could not save file	Failed to save the uploaded file
`0`	Module crm is not installed	The `crm` module is unavailable during DG processing
`0`	Wrong provider ...	Incorrect document provider defined
`0`	Application not found	Failed to determine the current REST application
`0`	Error generating file for template	Failed to create a service file for the hidden template
`0`	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 `documentgenerator` module is unavailable

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	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
`500`	`PORTAL_DELETED` Portal was deleted	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

Continue Learning

Enable or Disable Public Link for Document

Retrieve Document Fields

Upload Document crm.documentgenerator.document.upload

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type resultType result

Type documentType document

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning