метод REST scope: calendar

calendar.user.settings.set

Установить пользовательские настройки календаря

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

Описание

Метод устанавливает пользовательские настройки календаря для текущего пользователя.

Параметры

settings object обязательный

Объект со значениями пользовательских настроек календаря

Параметр settings

view string необязательный

Стандартное представление для календаря. Возможные значения:
- day — день
- week — неделя
- month — месяц
- list — список

meetSection string необязательный

Календарь для приглашений

crmSection string необязательный

Календарь для CRM

showDeclined boolean необязательный

Показывать события, в которых пользователь отказался принять участие

denyBusyInvitation boolean необязательный

Запрещать приглашать в событие, если время занято

collapseOffHours string необязательный

Скрывать нерабочее время в календаре в недельном и дневном представлении. Возможные значения:
- Y — скрывать
- N — не скрывать

showWeekNumbers string необязательный

Показывать номер недель. Возможные значения:
- Y — показывать
- N — не показывать

showTasks string необязательный

Отображать задачи в календаре. Возможные значения:
- Y — отображать
- N — не отображать

syncTasks string необязательный

Синхронизировать календарь задач. Возможные значения:
- Y — да
- N — нет

showCompletedTasks string необязательный

Отображать завершенные задачи. Возможные значения:
- Y — отображать
- N — не отображать

lastUsedSection string необязательный

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

Значение по умолчанию — false

sendFromEmail string необязательный

E-mail для отправки почтовых приглашений

defaultSections object необязательный

Настройки предустановленных календарей.

Ключем объекта настроек может быть:
- user[id] — тип Календарь пользователя c идентификатором пользователя. Например, user12 соответствует календарю пользователя с идентификатором 12
- group[id] — тип Календарь группы с идентификатором группы. Например, group36 соответствует календарю группы с идентификатором 36

Значением объекта является идентификатор календаря

syncPeriodPast string необязательный

Количество месяцев для синхронизации в прошлом периоде

syncPeriodFuture string необязательный

Количество месяцев для синхронизации в будущем периоде

defaultReminders object необязательный

Объект со стандартными настройками напоминаний о событии

Объект defaultReminders

fullDay array необязательный

Массив стандартных настроек напоминаний для целодневных событий

withTime array необязательный

Массив стандартных настроек напоминаний для событий с указанием времени

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"settings":{"view":"month","meetSection":"4","crmSection":"4","showDeclined":true,"denyBusyInvitation":false,"collapseOffHours":"N","showWeekNumbers":"N","showTasks":"Y","syncTasks":"N","showCompletedTasks":"N","lastUsedSection":"false","sendFromEmail":"","defaultSections":{"user1":"4","group6":"49"},"syncPeriodPast":"3","syncPeriodFuture":"12","defaultReminders":{"fullDay":[{"type":"min","count":15}],"withTime":[{"type":"min","count":50}]}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.user.settings.set

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1733318565.183275,
        "finish": 1733318565.695058,
        "duration": 0.5117831230163574,
        "processing": 0.29406094551086426,
        "date_start": "2024-12-04T13:22:45+00:00",
        "date_finish": "2024-12-04T13:22:45+00:00"
    }
}

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

result boolean

Возвращает true в случае успешного выполнения

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр \"settings\" для метода \"calendar.user.settings.set\""
}
Код Описание Значение
Не задан обязательный параметр "settings" для метода "calendar.user.settings.set" Не передан обязательный параметр settings

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

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