Update Event calendar.event.update
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
calendarWho can execute the method: any user
This method updates an existing event.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Event identifier. You can obtain the identifier using the calendar.event.get or calendar.event.get.nearest methods. |
|
type* |
Calendar type:
|
|
ownerId* |
Calendar owner identifier. For the company calendar, the |
|
from |
Start date and time of the event. You can specify the date without time. To do this, pass the value |
|
End date of the event. You can specify the date without time. To do this, pass the value |
|
|
from_ts |
Date and time in timestamp format. Can be used instead of the |
|
to_ts |
Date and time in timestamp format. Can be used instead of the |
|
section |
Calendar identifier. |
|
name* |
Event name. |
|
skip_time |
Pass the date value without time in the
Date format according to ISO-8601 standard. |
|
timezone_from |
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, |
|
timezone_to |
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, |
|
description |
Event description. |
|
color |
Background color of the event. The |
|
text_color |
Text color of the event. The |
|
accessibility |
Availability during the event time:
|
|
importance |
Event importance:
|
|
private_event |
Mark indicating that the event is private. Possible values:
|
|
recurrence_mode |
Parameter for partial editing of a recurring event. Possible values:
|
|
current_date_from |
Date of the current event for partial editing of a recurring event. Required only for |
|
rrule |
Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below. |
|
is_meeting |
Indicator of a meeting with event participants. Possible values:
For a meeting with participants, you must specify the list of participants in |
|
location |
Location. |
|
remind |
Array of objects describing reminders for the event. The structure is described below. |
|
attendees* |
List of participant identifiers for the event. This field is required if |
|
host* |
Identifier of the event organizer. This field is required if |
|
meeting |
Object with meeting parameters. The structure is described below. |
|
crm_fields |
Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:
|
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
fromandtoparameters:2025-03-20T15:00:00+02:00— with offset2025-08-05T10:00:00+11:00— with offset2025-08-04T23:00:00Z— with UTC specified
The
timezone_fromandtimezone_toparameters are ignored since the timezone is already specified in the date. -
Simple date format with separate timezone parameters.
Use the simple format in the
fromandtoparameters:2025-03-20 15:00:002025-08-05 10:00:002025-08-05T10:00:00
Specify the timezone in the
timezone_fromandtimezone_toparameters:Europe/RigaAmerica/New_YorkAsia/Tokyo
If only
timezone_fromis specified, its value will be used fortimezone_to.
Priority of timezone parameter processing:
- Highest priority. If the
fromandtoparameters are specified in full format with timezone, thetimezone_fromandtimezone_toparameters are ignored. - Medium priority. If a simple date format is used and
timezone_fromandtimezone_toparameters 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 |
Description |
|
FREQ |
Recurrence frequency
|
|
COUNT |
Number of recurrences. |
|
INTERVAL |
Interval between recurrences. |
|
BYDAY |
Days of the week
|
|
UNTIL |
End date of recurrences. |
remind Parameter
|
Name |
Description |
|
type |
Time type of reminder
|
|
count |
Numerical value of the time interval. |
meeting Parameter
|
Name |
Description |
|
notify |
Flag for notification of confirmation or refusal from participants. |
|
reinvite |
Flag for requesting re-confirmation of participation when editing the event. |
|
allow_invite |
Flag allowing participants to invite others to the event. |
|
hide_guests |
Flag for hiding the list of participants. |
Code Examples
How to Use Examples in Documentation
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
{
"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
|
Name |
Description |
|
result |
Identifier of the updated event. |
|
Name |
Description |
|
result |
Root element of the response. |
|
originalDate |
Start date of the new series of the recurring event. |
|
originalDavXmlId |
Event identifier for synchronization. |
|
instanceTz |
Event timezone. |
|
recEventId |
Identifier of the new series of the recurring event. |
|
id |
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 |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
Empty string |
The required parameter "ownerId" for the method "calendar.event.update" is not set. |
The required parameter |
|
Empty string |
The required parameter "type" for the method "calendar.event.update" is not set. |
The required parameter |
|
Empty string |
Invalid value for the "name" parameter. |
Incorrect data format in the |
|
Empty string |
Invalid value for the "description" parameter. |
Incorrect data format in the |
|
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 |
|
Empty string |
The event's CRM links list must be an array. |
Incorrect data format in the |
|
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 |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |