Enable or Disable Public Link for Document crm.documentgenerator.document.enablepublicurl

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.enablepublicurl enables or disables the public link for a document.

Method Parameters

Required parameters are marked with *

Name
type

Description

id^*
integer

Document identifier

status
integer

Public link mode:

1 — enable
0 — disable

Default: 1

Code Examples

How to Use Examples in Documentation

The example enables the public link for document 61.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61,"status":1}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.enablepublicurl

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61,"status":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.enablepublicurl

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.document.enablepublicurl',
        		{
        			id: 61,
        			status: 1,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.enablepublicurl',
                    [
                        'id' => 61,
                        'status' => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error enabling public URL: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.document.enablepublicurl',
            {
                id: 61,
                status: 1,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.enablepublicurl',
            [
                'id' => 61,
                'status' => 1,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "publicUrl": "https://bitrix.bitrix24.com/~71q5j"
            },
            "time": {
                "start": 1774011939,
                "finish": 1774011939.899233,
                "duration": 0.8992331027984619,
                "processing": 0,
                "date_start": "2026-03-20T16:05:39+01:00",
                "date_finish": "2026-03-20T16:05:39+01:00",
                "operating_reset_at": 1774012539,
                "operating": 0.3236720561981201
            }
        }

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
publicUrl `string` \| `null`	Public link to the document. Returns `null` when `status = 0`

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Document not found"
        }

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`	Bitrix\DocumentGenerator\Document constructor must be is public	Required parameter `id` not provided
`DOCGEN_ACCESS_ERROR`	Access denied	No access to the document
`0`	Document not found	Document with the specified `id` not found
`Empty value`	Document not found	Document does not belong to the `crm` module
`Empty value`	You do not have permissions to modify this document	Insufficient permissions to modify the document
`Empty value`	You do not have permissions to view documents	Insufficient permissions to view document generator 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

Delete Document

Upload Generated Document and Attach it to Specified CRM Entity

Enable or Disable Public Link for Document crm.documentgenerator.document.enablepublicurl

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type resultType result

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning