Add Calendar calendar.section.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:
calendarWho can execute the method: any user except collab users
The calendar.section.add method adds a new calendar.
The method does not check whether the user from ownerId exists or whether the caller has rights to their calendar.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
type* |
Calendar type. Possible values:
|
|
ownerId |
Identifier of the calendar owner. Required for all calendar types except |
|
name* |
Calendar name |
|
description |
Calendar description |
|
color |
Calendar color in |
|
text_color |
Text color in the calendar in |
|
export |
Object of the calendar export parameters (detailed description) |
|
access |
Object of the calendar access rights (detailed description) |
Export Parameter
Export settings are saved only if both fields are passed — ALLOW and SET. If only one field is passed, the method creates a calendar with the default values.
|
Name |
Description |
|
ALLOW |
Allow calendar export. Possible values:
|
|
SET |
Period for export. Possible values:
The method does not save the parameter value: the export period is always |
Access Parameter
The object key is the access code, the value is the numeric permission identifier. The format matches the ACCESS field in the calendar.section.get response.
If the user has no right to manage calendar access, the method silently ignores the passed object and sets the default rights. An empty {} object also sets the default rights.
|
Name |
Description |
|
Access Code |
Code of the object the right is granted to: |
|
Permission Identifier |
Numeric code of the access right permission. The identifiers differ between Bitrix24 instances: an administrator of an on-premise Bitrix24 can find them out |
Example value:
{
"access": {
"U1": 19,
"G2": 13
}
}
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":2,"name":"New Section","description":"Description for section","color":"#9cbeee","text_color":"#283000","export":{"ALLOW":false,"SET":"3_9"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.section.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":2,"name":"New Section","description":"Description for section","color":"#9cbeee","text_color":"#283000","export":{"ALLOW":false,"SET":"3_9"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.section.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 CalendarSectionAddResult = number
try {
const response = await $b24.actions.v2.call.make<CalendarSectionAddResult>({
method: 'calendar.section.add',
params: {
type: 'user',
ownerId: 2,
name: 'New Section',
description: 'Description for section',
color: '#9cbeee',
text_color: '#283000',
export: {
ALLOW: false,
SET: '3_9',
},
},
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('Created calendar with ID:', result)
}
} 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 addCalendarSection() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.section.add',
params: {
type: 'user',
ownerId: 2,
name: 'New Section',
description: 'Description for section',
color: '#9cbeee',
text_color: '#283000',
export: {
ALLOW: false,
SET: '3_9',
},
},
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('Created calendar with ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCalendarSection)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.section.add(
type="user",
owner_id=2,
name="New Section",
description="Description for section",
color="#9cbeee",
text_color="#283000",
export={
"ALLOW": False,
"SET": "3_9",
},
).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(
'calendar.section.add',
[
'type' => 'user',
'ownerId' => 2,
'name' => 'New Section',
'description' => 'Description for section',
'color' => '#9cbeee',
'text_color' => '#283000',
'export' => [
'ALLOW' => false,
'SET' => '3_9',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Next, process $result in your code
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding calendar section: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.section.add',
{
type: 'user',
ownerId: 2,
name: 'New Section',
description: 'Description for section',
color: '#9cbeee',
text_color: '#283000',
export: {
ALLOW: false,
SET: '3_9'
}
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.section.add',
[
'type' => 'user',
'ownerId' => 2,
'name' => 'New Section',
'description' => 'Description for section',
'color' => '#9cbeee',
'text_color' => '#283000',
'export' => [
'ALLOW' => false,
'SET' => '3_9'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "calendar.section.add", b24.Params{
"type": "user",
"ownerId": 2,
"name": "New Section",
"description": "Description for section",
"color": "#9cbeee",
"text_color": "#283000",
"export": b24.Params{
"ALLOW": false,
"SET": "3_9",
},
})
if err != nil {
return fmt.Errorf("calendar.section.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP Status: 200
{
"result": 190,
"time": {
"start": 1733812564.64201,
"finish": 1733812565.71673,
"duration": 1.0747201442718506,
"processing": 0.05963897705078125,
"date_start": "2024-12-08T06:36:04+00:00",
"date_finish": "2024-12-08T06:36:05+00:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created calendar |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "The mandatory parameter \"type\" is not specified for the method \"calendar.section.add\""
}
|
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 |
|
|
Empty value |
The mandatory parameter "type" is not specified for the method "calendar.section.add" |
The required parameter |
|
|
Empty value |
The mandatory parameter "ownerId" is not specified for the method "calendar.section.add" |
The required parameter |
|
|
Empty value |
Invalid parameter value for "name" |
The |
|
|
Empty value |
Invalid parameter value for "description" |
Incorrect data format in the |
|
|
Empty value |
Access denied |
For |
|
|
Empty value |
Error while creating section |
Another error |
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 |