Update Event calendar.event.update

Scope: calendar

Who can execute the method: any user

This method updates an existing event.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Event identifier. You can obtain the identifier using the calendar.event.get or calendar.event.get.nearest methods.
type* `string`	Calendar type: `user` — user calendar `group` — group calendar `company_calendar` — company calendar
ownerId* `integer`	Calendar owner identifier. For the company calendar, the `ownerId` parameter is `0`.
from `datetime`\|`date`	Start date and time of the event. You can specify the date without time. To do this, pass the value `Y` in the `skip_time` parameter.
to `datetime`\|`date`	End date of the event. You can specify the date without time. To do this, pass the value `Y` in the `skip_time` parameter.
from_ts `integer`	Date and time in timestamp format. Can be used instead of the `from` parameter.
to_ts `integer`	Date and time in timestamp format. Can be used instead of the `to` parameter.
section `integer`	Calendar identifier.
name* `string`	Event name.
skip_time `string`	Pass the date value without time in the `from` and `to` parameters. Possible values: `Y` — use only the date `N` — use date and time Date format according to ISO-8601 standard.
timezone_from `string`	Timezone of the start date and time of the event. Default is the current user's timezone. The value should be passed as a string, for example, `Europe/Riga`. Timezone handling features
timezone_to `string`	Timezone of the end date and time of the event. Default value is the current user's timezone. The value should be passed as a string, for example, `Europe/Riga`. Timezone handling features
description `text`	Event description.
color `string`	Background color of the event. The `#` symbol in the color must be passed in unicode format — `%23`.
text_color `string`	Text color of the event. The `#` symbol in the color must be passed in unicode format — `%23`.
accessibility `string`	Availability during the event time: `busy` — busy `absent` — absent `quest` — tentative `free` — free
importance `string`	Event importance: `high` — high `normal` — medium `low` — low
private_event `string`	Mark indicating that the event is private. Possible values: `Y` — private `N` — not private
recurrence_mode `string`	Parameter for partial editing of a recurring event. Possible values: `this` — changes apply only to the current event. Must specify `current_date_from`. `next` — changes apply to the current and all following events. Must specify `current_date_from`. `all` — changes apply to all events in the recurrence chain.
current_date_from `date`	Date of the current event for partial editing of a recurring event. Required only for `recurrence_mode` with values `this` or `next`.
rrule `object`	Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below.
is_meeting `string`	Indicator of a meeting with event participants. Possible values: `Y` — meeting with participants `N` — meeting without participants For a meeting with participants, you must specify the list of participants in `attendees` and the event organizer in `host`. Without filling these fields, the event will not be created.
location `string`	Location.
remind `array`	Array of objects describing reminders for the event. The structure is described below.
attendees* `array`	List of participant identifiers for the event. This field is required if `is_meeting` = `Y`.
host* `string`	Identifier of the event organizer. This field is required if `is_meeting` = `Y`.
meeting `object`	Object with meeting parameters. The structure is described below.
crm_fields `array`	Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes: `CO_` — company `C_` — contact `L_` — lead `D_` — deal.

Timezone Handling Features

When working with event dates and times, you can use two approaches:

Full date format with timezone.

Use the ISO-8601 format with timezone specified in the from and to parameters:
- 2025-03-20T15:00:00+02:00 — with offset
- 2025-08-05T10:00:00+11:00 — with offset
- 2025-08-04T23:00:00Z — with UTC specified
The timezone_from and timezone_to parameters are ignored since the timezone is already specified in the date.
Simple date format with separate timezone parameters.

Use the simple format in the from and to parameters:
- 2025-03-20 15:00:00
- 2025-08-05 10:00:00
- 2025-08-05T10:00:00
Specify the timezone in the timezone_from and timezone_to parameters:
- Europe/Riga
- America/New_York
- Asia/Tokyo
If only timezone_from is specified, its value will be used for timezone_to.

Priority of timezone parameter processing:

Highest priority. If the from and to parameters are specified in full format with timezone, the timezone_from and timezone_to parameters are ignored.
Medium priority. If a simple date format is used and timezone_from and timezone_to parameters are specified, they are used.
Lowest priority. If the date format is simple and timezone parameters are not specified, the current user's timezone is used.

rrule Parameter

Name `type`	Description
FREQ `string`	Recurrence frequency `DAILY` — daily `WEEKLY` — weekly `MONTHLY` — monthly `YEARLY` — yearly
COUNT `integer`	Number of recurrences.
INTERVAL `integer`	Interval between recurrences.
BYDAY `array`	Days of the week `SU` — Sunday `MO` — Monday `TU` — Tuesday `WE` — Wednesday `TH` — Thursday `FR` — Friday `SA` — Saturday.
UNTIL `date`	End date of recurrences.

remind Parameter

Name
type

Description

type
string

Time type of reminder

min — minutes
hour – hours
day — days.

count
integer

Numerical value of the time interval.

meeting Parameter

Name `type`	Description
notify `boolean`	Flag for notification of confirmation or refusal from participants.
reinvite `boolean`	Flag for requesting re-confirmation of participation when editing the event.
allow_invite `boolean`	Flag allowing participants to invite others to the event.
hide_guests `boolean`	Flag for hiding the list of participants.

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 '{"id":699,"type":"user","ownerId":2,"name":"Changed Event Name","description":"New description for event","from":"2024-06-17","to":"2024-06-17","skip_time":"Y","section":5,"color":"#9cbe1c","text_color":"#283033","accessibility":"free","importance":"normal","is_meeting":"Y","private_event":"Y","recurrence_mode":"next","current_date_from":"2024-12-04","remind":[{"type":"min","count":10}],"location":"London","attendees":[1,2,3],"host":2,"meeting":{"notify":true,"reinvite":false,"allow_invite":false,"hide_guests":false},"rrule":{"FREQ":"WEEKLY","BYDAY":["MO","WE"],"COUNT":10,"INTERVAL":1},"crm_fields":["C_5","L_11"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.event.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":699,"type":"user","ownerId":2,"name":"Changed Event Name","description":"New description for event","from":"2024-06-17","to":"2024-06-17","skip_time":"Y","section":5,"color":"#9cbe1c","text_color":"#283033","accessibility":"free","importance":"normal","is_meeting":"Y","private_event":"Y","recurrence_mode":"next","current_date_from":"2024-12-04","remind":[{"type":"min","count":10}],"location":"London","attendees":[1,2,3],"host":2,"meeting":{"notify":true,"reinvite":false,"allow_invite":false,"hide_guests":false},"rrule":{"FREQ":"WEEKLY","BYDAY":["MO","WE"],"COUNT":10,"INTERVAL":1},"crm_fields":["C_5","L_11"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/calendar.event.update

try
        {
        	const response = await $b24.callMethod(
        		'calendar.event.update',
        		{
        			id: 699,
        			type: 'user',
        			ownerId: 2,
        			name: 'Changed Event Name',
        			description: 'New description for event',
        			from: '2024-06-17',
        			to: '2024-06-17',
        			skip_time: 'Y',
        			section: 5,
        			color: '#9cbe1c',
        			text_color: '#283033',
        			accessibility: 'free',
        			importance: 'normal',
        			is_meeting: 'Y',
        			private_event: 'Y',
        			recurrence_mode: 'next',
        			current_date_from: '2024-12-04',
        			remind: [
        				{
        					type: 'min',
        					count: 10
        				}
        			],
        			location: 'London',
        			attendees: [1, 2, 3],
        			host: 2,
        			meeting: {
        				notify: true,
        				reinvite: false,
        				allow_invite: false,
        				hide_guests: false,
        			},
        			rrule: {
        				FREQ: 'WEEKLY',
        				BYDAY: ['MO', 'WE'],
        				COUNT: 10,
        				INTERVAL: 1,
        			},
        			crm_fields: ['C_5', 'L_11']
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('Updated event with ID:', result);
        	// Your data processing logic
        	processResult(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'calendar.event.update',
                    [
                        'id'              => 699,
                        'type'            => 'user',
                        'ownerId'         => 2,
                        'name'            => 'Changed Event Name',
                        'description'     => 'New description for event',
                        'from'            => '2024-06-17',
                        'to'              => '2024-06-17',
                        'skip_time'       => 'Y',
                        'section'         => 5,
                        'color'           => '#9cbe1c',
                        'text_color'      => '#283033',
                        'accessibility'   => 'free',
                        'importance'      => 'normal',
                        'is_meeting'      => 'Y',
                        'private_event'   => 'Y',
                        'recurrence_mode' => 'next',
                        'current_date_from' => '2024-12-04',
                        'remind'          => [
                            [
                                'type'  => 'min',
                                'count' => 10
                            ]
                        ],
                        'location'        => 'London',
                        'attendees'       => [1, 2, 3],
                        'host'            => 2,
                        'meeting'         => [
                            'notify'      => true,
                            'reinvite'    => false,
                            'allow_invite' => false,
                            'hide_guests' => false,
                        ],
                        'rrule'           => [
                            'FREQ'     => 'WEEKLY',
                            'BYDAY'    => ['MO', 'WE'],
                            'COUNT'    => 10,
                            'INTERVAL' => 1,
                        ],
                        'crm_fields'      => ['C_5', 'L_11']
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating calendar event: ' . $e->getMessage();
        }

BX24.callMethod(
            'calendar.event.update',
            {
                id: 699,
                type: 'user',
                ownerId: 2,
                name: 'Changed Event Name',
                description: 'New description for event',
                from: '2024-06-17',
                to: '2024-06-17',
                skip_time: 'Y',
                section: 5,
                color: '#9cbe1c',
                text_color: '#283033',
                accessibility: 'free',
                importance: 'normal',
                is_meeting: 'Y',
                private_event: 'Y',
                recurrence_mode: 'next',
                current_date_from: '2024-12-04',
                remind: [
                    {
                        type: 'min',
                        count: 10
                    }
                ],
                location: 'London',
                attendees: [1, 2, 3],
                host: 2,
                meeting: {
                    notify: true,
                    reinvite: false,
                    allow_invite: false,
                    hide_guests: false,
                },
                rrule: {
                    FREQ: 'WEEKLY',
                    BYDAY: ['MO', 'WE'],
                    COUNT: 10,
                    INTERVAL: 1,
                },
                crm_fields: ['C_5', 'L_11']
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'calendar.event.update',
            [
                'id' => 699,
                'type' => 'user',
                'ownerId' => 2,
                'name' => 'Changed Event Name',
                'description' => 'New description for event',
                'from' => '2024-06-17',
                'to' => '2024-06-17',
                'skip_time' => 'Y',
                'section' => 5,
                'color' => '#9cbe1c',
                'text_color' => '#283033',
                'accessibility' => 'free',
                'importance' => 'normal',
                'is_meeting' => 'Y',
                'private_event' => 'Y',
                'recurrence_mode' => 'next',
                'current_date_from' => '2024-12-04',
                'remind' => [
                    [
                        'type' => 'min',
                        'count' => 10
                    ]
                ],
                'location' => 'London',
                'attendees' => [1, 2, 3],
                'host' => 2,
                'meeting' => [
                    'notify' => true,
                    'reinvite' => false,
                    'allow_invite' => false,
                    'hide_guests' => false,
                ],
                'rrule' => [
                    'FREQ' => 'WEEKLY',
                    'BYDAY' => ['MO', 'WE'],
                    'COUNT' => 10,
                    'INTERVAL' => 1,
                ],
                'crm_fields' => ['C_5', 'L_11']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

Single Event

Recurring Event

{
            "result": 1246,
            "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": {
                "originalDate": "12/24/2024 05:59:00 pm",
                "originalDavXmlId": "20241205T124346Z-e3ccab8aebc16d0c5cccecb63fef2bc3@b24evo.lan",
                "instanceTz": "Europe/Riga",
                "recEventId": 1261,
                "id": 1260
            },
            "time": {
                "start": 1733402626.139122,
                "finish": 1733402626.740063,
                "duration": 0.6009409427642822,
                "processing": 0.3765721321105957,
                "date_start": "2024-12-05T12:43:46+00:00",
                "date_finish": "2024-12-05T12:43:46+00:00"
            }
        }

Returned Data

Single Event

Recurring Event

Name `type`	Description
result `integer`	Identifier of the updated event.

Name `type`	Description
result `object`	Root element of the response.
originalDate `datetime`	Start date of the new series of the recurring event.
originalDavXmlId `string`	Event identifier for synchronization.
instanceTz `string`	Event timezone.
recEventId `integer`	Identifier of the new series of the recurring event.
id `integer`	Identifier of the previous series of the recurring event.

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "The required parameter "ownerId" for the method "calendar.event.update" 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 "id" for the method "calendar.event.update" is not set.	The required parameter `id` is not provided.
Empty string	The required parameter "ownerId" for the method "calendar.event.update" is not set.	The required parameter `ownerId` is not provided.
Empty string	The required parameter "type" for the method "calendar.event.update" is not set.	The required parameter `type` is not provided.
Empty string	Invalid value for the "name" parameter.	Incorrect data format in the `name` field.
Empty string	Invalid value for the "description" parameter.	Incorrect data format in the `description` field.
Empty string	Access denied.	Creating events in the specified calendar is prohibited.
Empty string	You specified an invalid calendar section ID or the user does not have access to it.	An identifier of an inaccessible or non-existent calendar is provided.
Empty string	An invalid editing type for the recurring event is specified.	An incorrect value for the `recurrence_mode` field is provided.
Empty string	The event's CRM links list must be an array.	Incorrect data format in the `crm_fields` field.
Empty string	An error occurred while changing the event.	Another error.

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

Add Event

Get Event by ID

Update Event calendar.event.update

Method ParametersMethod Parameters

Timezone Handling FeaturesTimezone Handling Features

rrule Parameterrrule Parameter

remind Parameterremind Parameter

meeting Parametermeeting Parameter

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