Add Role documentgenerator.role.add

Scope: documentgenerator

Who can execute the method: user with permission to modify document generator settings

The method documentgenerator.role.add adds a new role.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Role fields (detailed description)

Parameter fields

Name `type`	Description
name* `string`	Role name
code `string`	Symbolic role code
permissions `object`	Role permissions (detailed description). Keys within `permissions` are case-sensitive. Only pass them in uppercase: `SETTINGS`, `TEMPLATES`, `DOCUMENTS` `MODIFY`, `VIEW` If keys are passed in lowercase, the role will be saved, but permissions will be empty.

Object permissions

Name `type`	Description
SETTINGS `object`	Permissions for settings (detailed description)
TEMPLATES `object`	Permissions for templates (detailed description)
DOCUMENTS `object`	Permissions for documents (detailed description)

Object settings

Name
type

Description

MODIFY
string

Access level to settings. Possible values:

"" — no access
X — full access

Object templates

Name
type

Description

MODIFY
string

Access level to templates. Possible values:

"" — no access
A — only own items
D — own and department colleagues' items
X — full access

Object documents

Name
type

Description

MODIFY
string

Access level for modifying documents. Possible values:

"" — no access
X — full access

VIEW
string

Access level for viewing documents. Possible values:

"" — no access
X — full access

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 '{
            "fields": {
              "name": "Template Editors",
              "code": "DOCGEN_TEMPLATE_EDITORS",
              "permissions": {
                "SETTINGS": {
                  "MODIFY": ""
                },
                "TEMPLATES": {
                  "MODIFY": "D"
                },
                "DOCUMENTS": {
                  "MODIFY": "X",
                  "VIEW": "X"
                }
              }
            }
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "name": "Template Editors",
              "code": "DOCGEN_TEMPLATE_EDITORS",
              "permissions": {
                "SETTINGS": {
                  "MODIFY": ""
                },
                "TEMPLATES": {
                  "MODIFY": "D"
                },
                "DOCUMENTS": {
                  "MODIFY": "X",
                  "VIEW": "X"
                }
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.role.add

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.role.add',
                {
                    fields: {
                        name: 'Template Editors',
                        code: 'DOCGEN_TEMPLATE_EDITORS',
                        permissions: {
                            SETTINGS: {
                                MODIFY: ''
                            },
                            TEMPLATES: {
                                MODIFY: 'D'
                            },
                            DOCUMENTS: {
                                MODIFY: 'X',
                                VIEW: 'X'
                            }
                        }
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.role.add',
                [
                    'fields' => [
                        'name' => 'Template Editors',
                        'code' => 'DOCGEN_TEMPLATE_EDITORS',
                        'permissions' => [
                            'SETTINGS' => [
                                'MODIFY' => '',
                            ],
                            'TEMPLATES' => [
                                'MODIFY' => 'D',
                            ],
                            'DOCUMENTS' => [
                                'MODIFY' => 'X',
                                'VIEW' => 'X',
                            ],
                        ],
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.role.add',
            {
                fields: {
                    name: 'Template Editors',
                    code: 'DOCGEN_TEMPLATE_EDITORS',
                    permissions: {
                        SETTINGS: {
                            MODIFY: ''
                        },
                        TEMPLATES: {
                            MODIFY: 'D'
                        },
                        DOCUMENTS: {
                            MODIFY: 'X',
                            VIEW: 'X'
                        }
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.role.add',
            [
                'fields' => [
                    'name' => 'Template Editors',
                    'code' => 'DOCGEN_TEMPLATE_EDITORS',
                    'permissions' => [
                        'SETTINGS' => [
                            'MODIFY' => '',
                        ],
                        'TEMPLATES' => [
                            'MODIFY' => 'D',
                        ],
                        'DOCUMENTS' => [
                            'MODIFY' => 'X',
                            'VIEW' => 'X',
                        ],
                    ],
                ],
            ]
        );
        
        print_r($result);

Response Handling

HTTP status: 200

{
            "result": {
                "role": {
                    "id": 9,
                    "name": "Template Editors",
                    "code": "DOCGEN_TEMPLATE_EDITORS",
                    "permissions": {
                        "settings": {
                            "modify": ""
                        },
                        "templates": {
                            "modify": "D"
                        },
                        "documents": {
                            "modify": "X",
                            "view": "X"
                        }
                    }
                }
            },
            "time": {
                "start": 1774008850,
                "finish": 1774008850.528288,
                "duration": 0.5282878875732422,
                "processing": 0,
                "date_start": "2026-03-20T15:14:10+02:00",
                "date_finish": "2026-03-20T15:14:10+02:00",
                "operating_reset_at": 1774009450,
                "operating": 0
            }
        }

Returned Data

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

Object result

Name `type`	Description
role `object`	Data of the created role (detailed description)

Object role

Name `type`	Description
id `integer`	Role identifier
name `string`	Role name
code `string`	Symbolic role code
permissions `object`	Role permissions (detailed description)

Object permissions

Name `type`	Description
settings `object`	Permissions for settings (detailed description)
templates `object`	Permissions for templates (detailed description)
documents `object`	Permissions for documents (detailed description)

Object settings

Name
type

Description

modify
string

Access level to settings
Possible values:

"" — no access
X — full access

Object templates

Name
type

Description

modify
string

Access level to templates
Possible values:

"" — no access
A — only own items
D — own and department colleagues' items
X — full access

Object documents

Name
type

Description

modify
string

Access level for modifying documents
Possible values:

"" — no access
X — full access

view
string

Access level for viewing documents
Possible values:

"" — no access
X — full access

Error Handling

HTTP status: 400, 403

{
            "error": "100",
            "error_description": "Could not find value for parameter {fields}"
        }

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`	Could not find value for parameter	Required parameter `fields` was not provided or was empty
`400`	`BX_EMPTY_REQUIRED`	Required field "NAME" is not filled	Required field `name` was not provided in the `fields` parameter
`400`	`0`	You do not have permissions to modify settings	Insufficient permissions to modify document generator settings
`403`	`DOCGEN_ACCESS_ERROR`	Your plan does not support this operation	The plan does not support the function of permission management for the document generator

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

Overview of Methods

Update Role

Add Role documentgenerator.role.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Object permissionsObject permissions

Object settingsObject settings

Object templatesObject templates

Object documentsObject documents

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object roleObject role

Object permissionsObject permissions

Object settingsObject settings

Object templatesObject templates

Object documentsObject documents

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter fields

Object permissions

Object settings

Object templates

Object documents

Code Examples

Response Handling

Returned Data

Object result

Object role

Object permissions

Object settings

Object templates

Object documents

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning