Set User Calendar Settings calendar.user.settings.set

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: calendar

Who can execute the method: any user

This method sets user calendar settings for the current user.

Method Parameters

Required parameters are marked with *

Name `type`	Description
settings* `object`	An object with values for user calendar settings

Parameter settings

view `string`	Default view for the calendar. Possible values: `day` — day `week` — week `month` — month `list` — list
meetSection `string`	Calendar for invitations
crmSection `string`	Calendar for CRM
showDeclined `boolean`	Show events that the user declined to participate in
denyBusyInvitation `boolean`	Prevent inviting to an event if the time is busy
collapseOffHours `string`	Hide non-working hours in the calendar in weekly and daily views. Possible values: `Y` — hide `N` — do not hide
showWeekNumbers `string`	Show week numbers. Possible values: `Y` — show `N` — do not show
showTasks `string`	Display tasks in the calendar. Possible values: `Y` — display `N` — do not display
syncTasks `string`	Synchronize task calendar. Possible values: `Y` — yes `N` — no
showCompletedTasks `string`	Display completed tasks. Possible values: `Y` — display `N` — do not display
lastUsedSection `string`	Identifier of the calendar used when creating events if the calendar identifier is not provided in the parameters. Default value — `false`
sendFromEmail `string`	E-mail for sending mail invitations
defaultSections `object`	Settings for preset calendars. The key of the settings object can be: `user[id]` — User Calendar type with user identifier. For example, `user12` corresponds to the calendar of the user with identifier `12` `group[id]` — Group Calendar type with group identifier. For example, `group36` corresponds to the calendar of the group with identifier `36` The value of the object is the calendar identifier
syncPeriodPast `string`	Number of months for synchronization in the past period
syncPeriodFuture `string`	Number of months for synchronization in the future period
defaultReminders `object`	An object with standard event reminder settings

Object defaultReminders

Name `type`	Description
fullDay `array`	Array of standard reminder settings for all-day events
withTime `array`	Array of standard reminder settings for timed events

Reminder settings object

Name
type

Description

type
string

Time type of reminder. Possible values:

min — minutes
hour — hours
day — days

count
integer

Numeric value of the time interval

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {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);
            // Your required data processing logic
            processData($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 and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        fmt.Println("done:", ok)

Response Handling

HTTP status: 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"
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the execution was successful

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "The required parameter \"settings\" for the method \"calendar.user.settings.set\" is not set"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Error Message	Description
Empty value	The required parameter "settings" for the method "calendar.user.settings.set" is not set	The required parameter `settings` was not provided

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Get User Calendar Settings

How to Embed Application in Calendar

Set User Calendar Settings calendar.user.settings.set

Method ParametersMethod Parameters

Parameter settingsParameter settings

Object defaultRemindersObject defaultReminders

Reminder settings objectReminder settings object

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