Change Role documentgenerator.role.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: documentgenerator

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

The method documentgenerator.role.update updates a role by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Role identifier.

You can obtain the identifier after creating a role or by using the get list of roles method

fields*
object

Set of fields to update (detailed description)

Parameter fields

Name
type

Description

name
string

New role name

code
string

New symbolic code for the role

permissions
object

New set of role permissions (detailed description).

Warning

Keys within permissions are case-sensitive. Please provide them in uppercase only:

  • SETTINGS, TEMPLATES, DOCUMENTS
  • MODIFY, VIEW

If keys are provided in lowercase, the role permissions will be reset to empty values.

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 to modify documents. Possible values:

  • "" — no access
  • X — full access

VIEW
string

Access level to view documents. Possible values:

  • "" — no access
  • X — full access

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "id": 9,
            "fields": {
              "name": "Template Editors",
              "permissions": {
                "SETTINGS": {
                  "MODIFY": ""
                },
                "TEMPLATES": {
                  "MODIFY": "A"
                },
                "DOCUMENTS": {
                  "MODIFY": "X",
                  "VIEW": "X"
                }
              }
            }
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.update
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "id": 9,
            "fields": {
              "name": "Template Editors",
              "permissions": {
                "SETTINGS": {
                  "MODIFY": ""
                },
                "TEMPLATES": {
                  "MODIFY": "A"
                },
                "DOCUMENTS": {
                  "MODIFY": "X",
                  "VIEW": "X"
                }
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.role.update
        
// 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type RoleUpdateResult = {
          role: {
            id: number
            name: string
            code: string
            permissions: {
              settings: { modify: string }
              templates: { modify: string }
              documents: { modify: string; view: string }
            }
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<RoleUpdateResult>({
            method: 'documentgenerator.role.update',
            params: {
              id: 9,
              fields: {
                name: 'Editors of own templates',
                permissions: {
                  SETTINGS: {
                    MODIFY: '',
                  },
                  TEMPLATES: {
                    MODIFY: 'A',
                  },
                  DOCUMENTS: {
                    MODIFY: 'X',
                    VIEW: 'X',
                  },
                },
              },
            },
            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.role.id, result.role.name, result.role.code)
          }
        } 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 updateRole() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'documentgenerator.role.update',
                params: {
                  id: 9,
                  fields: {
                    name: 'Editors of own templates',
                    permissions: {
                      SETTINGS: {
                        MODIFY: '',
                      },
                      TEMPLATES: {
                        MODIFY: 'A',
                      },
                      DOCUMENTS: {
                        MODIFY: 'X',
                        VIEW: 'X',
                      },
                    },
                  },
                },
                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.role.id, result.role.name, result.role.code)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateRole)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.documentgenerator.role.update(
                bitrix_id=9,
                fields={
                    "name": "Editors of their own templates",
                    "permissions": {
                        "SETTINGS": {
                            "MODIFY": "",
                        },
                        "TEMPLATES": {
                            "MODIFY": "A",
                        },
                        "DOCUMENTS": {
                            "MODIFY": "X",
                            "VIEW": "X",
                        },
                    },
                },
            ).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(
                'documentgenerator.role.update',
                [
                    'id' => 9,
                    'fields' => [
                        'name' => 'Template Editors',
                        'permissions' => [
                            'SETTINGS' => [
                                'MODIFY' => '',
                            ],
                            'TEMPLATES' => [
                                'MODIFY' => 'A',
                            ],
                            'DOCUMENTS' => [
                                'MODIFY' => 'X',
                                'VIEW' => 'X',
                            ],
                        ],
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'documentgenerator.role.update',
            {
                id: 9,
                fields: {
                    name: 'Template Editors',
                    permissions: {
                        SETTINGS: {
                            MODIFY: ''
                        },
                        TEMPLATES: {
                            MODIFY: 'A'
                        },
                        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.update',
            [
                'id' => 9,
                'fields' => [
                    'name' => 'Template Editors',
                    'permissions' => [
                        'SETTINGS' => [
                            'MODIFY' => '',
                        ],
                        'TEMPLATES' => [
                            'MODIFY' => 'A',
                        ],
                        'DOCUMENTS' => [
                            'MODIFY' => 'X',
                            'VIEW' => 'X',
                        ],
                    ],
                ],
            ]
        );
        
        print_r($result);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "documentgenerator.role.update", b24.Params{
        	"id": 9,
        	"fields": b24.Params{
        		"name": "Template Editors",
        		"permissions": b24.Params{
        			"SETTINGS": b24.Params{
        				"MODIFY": "",
        			},
        			"TEMPLATES": b24.Params{
        				"MODIFY": "A",
        			},
        			"DOCUMENTS": b24.Params{
        				"MODIFY": "X",
        				"VIEW":   "X",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("documentgenerator.role.update: %w", err)
        }
        
        // The method wraps the response in an object with the "role" key.
        raw, ok := b24.Unwrap(res.Result, "role")
        if !ok {
        	return fmt.Errorf("no role key in the response")
        }
        
        var item struct {
        	ID   b24.ID `json:"id"`
        	Name string `json:"name"`
        	Code string `json:"code"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)
        

Response Handling

HTTP status: 200

{
            "result": {
                "role": {
                    "id": 9,
                    "name": "Template Editors",
                    "code": "DOCGEN_TEMPLATE_EDITORS",
                    "permissions": {
                        "settings": {
                            "modify": ""
                        },
                        "templates": {
                            "modify": "A"
                        },
                        "documents": {
                            "modify": "X",
                            "view": "X"
                        }
                    }
                }
            },
            "time": {
                "start": 1774014410,
                "finish": 1774014410.602927,
                "duration": 0.6029269695281982,
                "processing": 0,
                "date_start": "2026-03-20T16:46:50+02:00",
                "date_finish": "2026-03-20T16:46:50+02:00",
                "operating_reset_at": 1774015010,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response (detailed description)

time
time

Information about the execution time of the request

Object result

Name
type

Description

role
object

Data of the updated role (detailed description)

Object role

Name
type

Description

id
integer

Role identifier

name
string

Role name

code
string

Symbolic code for the role

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 to modify documents
Possible values:

  • "" — no access
  • X — full access

view
string

Access level to view documents
Possible values:

  • "" — no access
  • X — full access

Error Handling

HTTP status: 400, 403

{
            "error": "0",
            "error_description": "You do not have permissions to modify settings"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

100

Bitrix\DocumentGenerator\Model\Role All parameters in the constructor must have real class type

Required parameter id not provided

400

100

Could not construct parameter

Non-existent parameter id provided

400

100

Could not find value for parameter

Required parameter fields not provided or provided empty

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 permission management for the document generator

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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