Add Role documentgenerator.role.add
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:
documentgeneratorWho 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 |
Description |
|
fields* |
Role fields (detailed description) |
Parameter fields
|
Name |
Description |
|
name* |
Role name |
|
code |
Symbolic role code |
|
permissions |
Role permissions (detailed description). Keys within
If keys are passed in lowercase, the role will be saved, but permissions will be empty. |
Object permissions
|
Name |
Description |
|
SETTINGS |
Permissions for settings (detailed description) |
|
TEMPLATES |
Permissions for templates (detailed description) |
|
DOCUMENTS |
Permissions for documents (detailed description) |
Object settings
|
Name |
Description |
|
MODIFY |
Access level to settings. Possible values:
|
Object templates
|
Name |
Description |
|
MODIFY |
Access level to templates. Possible values:
|
Object documents
|
Name |
Description |
|
MODIFY |
Access level for modifying documents. Possible values:
|
|
VIEW |
Access level for viewing documents. Possible values:
|
Code Examples
How to Use Examples in Documentation
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
// 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 RoleAddResult = {
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<RoleAddResult>({
method: 'documentgenerator.role.add',
params: {
fields: {
name: 'Template Editors',
code: 'DOCGEN_TEMPLATE_EDITORS',
permissions: {
SETTINGS: {
MODIFY: '',
},
TEMPLATES: {
MODIFY: 'D',
},
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('Added role:', result.role.id, result.role.name)
}
} 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 addRole() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.role.add',
params: {
fields: {
name: 'Template Editors',
code: 'DOCGEN_TEMPLATE_EDITORS',
permissions: {
SETTINGS: {
MODIFY: '',
},
TEMPLATES: {
MODIFY: 'D',
},
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('Added role:', result.role.id, result.role.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addRole)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.documentgenerator.role.add(
fields={
"name": "Template editors",
"code": "DOCGEN_TEMPLATE_EDITORS",
"permissions": {
"SETTINGS": {
"MODIFY": "",
},
"TEMPLATES": {
"MODIFY": "D",
},
"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.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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "documentgenerator.role.add", b24.Params{
"fields": b24.Params{
"name": "Template Editors",
"code": "DOCGEN_TEMPLATE_EDITORS",
"permissions": b24.Params{
"SETTINGS": b24.Params{
"MODIFY": "",
},
"TEMPLATES": b24.Params{
"MODIFY": "D",
},
"DOCUMENTS": b24.Params{
"MODIFY": "X",
"VIEW": "X",
},
},
},
})
if err != nil {
return fmt.Errorf("documentgenerator.role.add: %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": "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 |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
role |
Data of the created role (detailed description) |
Object role
|
Name |
Description |
|
id |
Role identifier |
|
name |
Role name |
|
code |
Symbolic role code |
|
permissions |
Role permissions (detailed description) |
Object permissions
|
Name |
Description |
|
settings |
Permissions for settings (detailed description) |
|
templates |
Permissions for templates (detailed description) |
|
documents |
Permissions for documents (detailed description) |
Object settings
|
Name |
Description |
|
modify |
Access level to settings
|
Object templates
|
Name |
Description |
|
modify |
Access level to templates
|
Object documents
|
Name |
Description |
|
modify |
Access level for modifying documents
|
|
view |
Access level for viewing documents
|
Error Handling
HTTP status: 400, 403
{
"error": "100",
"error_description": "Could not find value for parameter {fields}"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Required field "NAME" is not filled |
Required field |
|
|
|
You do not have permissions to modify settings |
Insufficient permissions to modify document generator settings |
|
|
|
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: 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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |