Добавить календарь calendar.section.add

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: calendar

Кто может выполнять метод: любой пользователь

Метод добавляет новый календарь.

Система добавит новый календарь только для пользователя, который выполнит метод. Администратор может создавать календари для других пользователей.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

type*
string

Тип календаря. Возможные значения:

  • user — календарь пользователя
  • group — календарь группы

ownerId*
integer

Идентификатор владельца календаря.

Для type со значением user установится идентификатор текущего пользователя, если не передать значение в ownerId

name*
string

Название календаря

description
string

Описание календаря

color
string

Цвет календаря

text_color
string

Цвет текста в календаре

export
object

Объект параметров экспорта календаря

Параметр export

Название
тип

Описание

ALLOW
boolean

Разрешить экспорт календаря. Возможные значения:

  • true — разрешить
  • false — запретить

SET
string

Период, за который производить экспорт. Возможные значения:

  • all — за весь период
  • 3_9 — 3 месяца до и 9 после
  • 6_12 — 6 месяцев до и 12 после

Примеры кода

Как использовать примеры в документации

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);
        	// Нужная вам логика обработки данных
        	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);
            // Нужная вам логика обработки данных
            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>';

Обработка ответа

HTTP-статус: 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"
            }
        }

Возвращаемые данные

Название
тип

Описание

result
integer

Идентификатор созданного календаря

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "Не задан обязательный параметр "type" для метода "calendar.section.add""
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Сообщение об ошибке

Описание

Пустая строка

Не задан обязательный параметр "type" для метода "calendar.section.add"

Не передан обязательный параметр type

Пустая строка

Не задан обязательный параметр "ownerId" для метода "calendar.section.add"

Не передан обязательный параметр ownerId и параметр type не равен user

Пустая строка

Недопустимое значение параметра "name"

Передан неверный формат данных в поле name

Пустая строка

Недопустимое значение параметра "description"

Передан неверный формат данных в поле description

Пустая строка

Доступ запрещен

Нет прав для создания календаря с переданным type

Пустая строка

При создании секции произошла ошибка

Другая ошибка

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Обзор методов
Следующая
Обновить календарь