Установить пользовательские настройки календаря calendar.user.settings.set

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: calendar

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

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

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

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

Название
тип

Описание

settings*
object

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

Параметр settings

Все поля объекта settings необязательны. Поля верхнего уровня, которые не передали, метод оставляет без изменений. Если передать defaultSections или defaultReminders, сохраненное значение заменяется целиком: вложенные ключи, которых нет в новом значении, удаляются.

Поля timezoneName, timezoneOffsetUTC, timezoneDefaultName, work_time_start и work_time_end этот метод не устанавливает — их возвращает calendar.user.settings.get, а меняет сотрудник в интерфейсе календаря.

Метод сохраняет значения без проверки: неизвестные ключи игнорирует, а недопустимое значение известного ключа записывает как есть. Например, view: "zzz" сохранится и вернется в calendar.user.settings.get. Проверяйте значения на своей стороне.

Название
тип

Описание

view
string

Стандартное представление для календаря. Возможные значения:

  • day — день
  • week — неделя
  • month — месяц
  • list — список

meetSection
string|boolean

Идентификатор календаря для приглашений. По умолчанию false

crmSection
string|boolean

Идентификатор календаря для CRM. По умолчанию false

showDeclined
boolean

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

denyBusyInvitation
boolean

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

CalendarSelCont
string|boolean

Служебное поле интерфейса календаря. По умолчанию false

SPCalendarSelCont
string|boolean

Служебное поле интерфейса календаря. По умолчанию false

collapseOffHours
string

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

  • Y — скрывать
  • N — не скрывать

showWeekNumbers
string

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

  • Y — показывать
  • N — не показывать

showTasks
string

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

  • Y — отображать
  • N — не отображать

syncTasks
string

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

  • Y — да
  • N — нет

showCompletedTasks
string

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

  • Y — отображать
  • N — не отображать

lastUsedSection
string|boolean

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

По умолчанию false — календарь не выбран

sendFromEmail
string

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

defaultSections
object

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

Ключом объекта настроек может быть:

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

Значение — идентификатор календаря

syncPeriodPast
string|integer

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

syncPeriodFuture
string|integer

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

defaultReminders
object

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

Объект defaultReminders

Название
тип

Описание

fullDay
object|array

Настройки напоминаний для целодневных событий: один объект или массив объектов (подробное описание)

withTime
object|array

Настройки напоминаний для событий с указанием времени: один объект или массив объектов (подробное описание)

Значение defaultReminders перезаписывается целиком: чтобы изменить одно напоминание, передайте оба поля объекта в нужном виде.

Объект настроек напоминания

Название
тип

Описание

type
string

Временной тип напоминания. Возможные значения:

  • min — минуты
  • hour — часы
  • day — дни
  • daybefore — напоминание в заданное время дня события

count
integer|string

Числовое значение временного промежутка. Используется с типами min, hour и day. Можно передать числом или строкой

before
integer

Сдвиг напоминания в днях до дня события. Используется с типом daybefore. При 0 напоминание приходит в день события

time
integer

Время напоминания в минутах от начала дня. Используется с типом daybefore. При before: 0 и time: 480 напоминание приходит в день события в 08:00

Примеры кода

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

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
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}]}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.user.settings.set
// 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 CalendarUserSettingsSetResult = boolean

try {
  const response = await $b24.actions.v2.call.make<CalendarUserSettingsSetResult>({
    method: 'calendar.user.settings.set',
    params: {
      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,
            },
          ],
        },
      },
    },
    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('Settings saved:', 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 setCalendarUserSettings() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'calendar.user.settings.set',
        params: {
          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,
                },
              ],
            },
          },
        },
        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('Settings saved:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setCalendarUserSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.calendar.user.settings.set(
        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,
                    },
                ],
            },
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'calendar.user.settings.set',
            [
                '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
                            ]
                        ]
                    ]
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Дальше обработайте $result в своем коде

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error setting user calendar settings: ' . $e->getMessage();
}
BX24.callMethod(
    'calendar.user.settings.set',
    {
        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
                    }
                ]
            }
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'calendar.user.settings.set',
    [
        '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
                    ]
                ]
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.user.settings.set", b24.Params{
	"settings": b24.Params{
		"view":               "month",
		"meetSection":        "4",
		"crmSection":         "4",
		"showDeclined":       true,
		"denyBusyInvitation": false,
		"collapseOffHours":   "N",
		"showWeekNumbers":    "N",
		"showTasks":          "Y",
		"syncTasks":          "N",
		"showCompletedTasks": "N",
		"lastUsedSection":    "false",
		"sendFromEmail":      "",
		"defaultSections": b24.Params{
			"user1":  "4",
			"group6": "49",
		},
		"syncPeriodPast":   "3",
		"syncPeriodFuture": "12",
		"defaultReminders": b24.Params{
			"fullDay": []b24.Params{
				{
					"type":  "min",
					"count": 15,
				},
			},
			"withTime": []b24.Params{
				{
					"type":  "min",
					"count": 50,
				},
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("calendar.user.settings.set: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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 при успешном выполнении

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

Пустое значение

Не задан обязательный параметр "settings" для метода "calendar.user.settings.set"

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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