метод REST scope: calendar

calendar.section.add

Добавить календарь

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

Описание

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

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

Параметры

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

Ответ

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\""
}
Код Описание Значение
Не задан обязательный параметр "type" для метода "calendar.section.add" Не передан обязательный параметр type
Не задан обязательный параметр "ownerId" для метода "calendar.section.add" Не передан обязательный параметр ownerId и параметр type не равен user
Недопустимое значение параметра "name" Передан неверный формат данных в поле name
Недопустимое значение параметра "description" Передан неверный формат данных в поле description
Доступ запрещен Нет прав для создания календаря с переданным type
При создании секции произошла ошибка Другая ошибка

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.