Enable or disable public link for document documentgenerator.document.enablepublicurl

Scope: documentgenerator

Who can execute the method: user with permission to modify documents

The method 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.

You can obtain the document identifier after creating a document or by using the get document list method

status
integer

Status of the public link:

1 - enable
0 - disable

Default is 1

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

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

try {
            $response = $b24Service->core->call(
                'documentgenerator.document.enablepublicurl',
                [
                    'id' => 51,
                    'status' => 1,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.document.enablepublicurl',
            {
                id: 51,
                status: 1
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.document.enablepublicurl',
            [
                'id' => 51,
                'status' => 1,
            ]
        );
        
        print_r($result);

Response Handling

HTTP status: 200

{
            "result": {
                    "publicUrl": "https://mysite.com/~nULUE"
            },
            "time": {
                "start": 1773913277,
                "finish": 1773913278.018128,
                "duration": 1.0181279182434082,
                "processing": 1,
                "date_start": "2026-03-19T12:41:17+02:00",
                "date_finish": "2026-03-19T12:41:18+02:00",
                "operating_reset_at": 1773913877,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

Result Object

Name
type

Description

publicUrl
string

Public link to the document

If status is set to 0, the field will return null

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

Status	Code	Description	Value
`400`	`100`	Bitrix\DocumentGenerator\Document constructor must be is public	Required parameter `id` not provided
`400`	`0`	Document not found	Document with the specified `id` not found
`400`	`0`	You do not have permissions to view documents	Insufficient permissions to modify the document

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Delete a Document

Get a List of Document Fields

Enable or disable public link for document documentgenerator.document.enablepublicurl

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning