Upload Document 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>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        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}")
        

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();
        }
        

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>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.documentgenerator.document.upload", b24.Params{
        	"fields": b24.Params{
        		"entityTypeId": 2,
        		"entityId":     101,
        		"fileContent":  "**base64_docx_content**",
        		"region":       "ru",
        		"title":        "Product demonstration",
        		"number":       "2026-001",
        		"pdfContent":   "**base64_pdf_content**",
        		"imageContent": "**base64_image_content**",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.documentgenerator.document.upload: %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)