Set User Calendar Settings calendar.user.settings.set

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)

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

try
        {
        	const response = await $b24.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
        						}
        					]
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('Result:', result);
        	// Your required data processing logic
        	processResult(result);
        }
        catch( error )
        {
        	console.error('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>';

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Error Message	Description
Empty string	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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

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