Add Calendar calendar.section.add

Scope: calendar

Who can execute the method: any user

This method adds a new calendar.

The system will add a new calendar only for the user who executes the method. An administrator can create calendars for other users.

Method Parameters

Required parameters are marked with *

Name `type`	Description
type* `string`	Calendar type. Possible values: `user` — user calendar `group` — group calendar
ownerId* `integer`	Identifier of the calendar owner. For `type` with the value `user`, the identifier of the current user will be set if no value is passed in `ownerId`
name* `string`	Calendar name
description `string`	Calendar description
color `string`	Calendar color
text_color `string`	Text color in the calendar
export `object`	Object export parameters for the calendar

Export Parameter

Name
type

Description

ALLOW
boolean

Allow calendar export. Possible values:

true — allow
false — disallow

SET
string

Period for export. Possible values:

all — for the entire period
3_9 — 3 months before and 9 after
6_12 — 6 months before and 12 after

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 '{"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

try
        {
        	const response = await $b24.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'
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('Created element with ID:', result);
        	// Your logic for processing data
        	processResult(result);
        }
        catch( error )
        {
        	console.error('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);
            // Your logic for processing data
            processData($result);
        
        } 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>';

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 `type`	Description
result `integer`	Identifier of the created calendar

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "The required parameter "type" for the method "calendar.section.add" is not set."
        }

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

Code	Error Message	Description
Empty string	The required parameter "type" for the method "calendar.section.add" is not set.	The required parameter `type` is not provided
Empty string	The required parameter "ownerId" for the method "calendar.section.add" is not set.	The required parameter `ownerId` is not provided and the `type` parameter is not equal to `user`
Empty string	Invalid value for the "name" parameter	Incorrect data format in the `name` field
Empty string	Invalid value for the "description" parameter	Incorrect data format in the `description` field
Empty string	Access denied	No permission to create a calendar with the provided `type`
Empty string	An error occurred while creating the section	Another error

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 Calendar

Add Calendar calendar.section.add

Method ParametersMethod Parameters

Export ParameterExport Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning