Update Event calendar.event.update
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:
calendarWho can execute the method: any user
The calendar.event.update 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. HEX format, for example |
|
text_color |
Text color of the event. HEX format, for example |
|
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 (detailed description) |
|
is_meeting |
Indicator of a meeting with event participants. Possible values:
For a meeting with participants, pass the list of participants in |
|
location |
Location. You can pass an arbitrary string, for example To book a meeting room, pass a string in the form |
|
doCheckOccupancy |
Whether to check the occupancy of the meeting room from
Default is |
|
remind |
Array of objects describing reminders for the event (detailed description) |
|
attendees |
List of participant identifiers for the event. If you pass |
|
host |
Meeting organizer identifier. The parameter is applied only together with If you pass The parameter does not grant permissions to the calendar, does not change the user on whose behalf the method is executed, and does not add the organizer to the attendee list automatically. You can retrieve the current organizer identifier in the response of the calendar.event.getbyid and calendar.event.get methods in the |
|
meeting |
Object with meeting parameters (detailed description) |
|
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
// 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 CalendarEventUpdateResult =
| number
| {
originalDate: string
originalDavXmlId: string
instanceTz: string
recEventId: number
id: number
}
try {
const response = await $b24.actions.v2.call.make<CalendarEventUpdateResult>({
method: 'calendar.event.update',
params: {
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'],
},
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('Updated calendar event:', 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 updateCalendarEvent() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.event.update',
params: {
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'],
},
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('Updated calendar event:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateCalendarEvent)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.event.update(
bitrix_id=699,
type="user",
owner_id=2,
name="Changed Event Name",
description="New description for event",
from_date="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",
],
).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.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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "calendar.event.update", b24.Params{
"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": []b24.Params{
{
"type": "min",
"count": 10,
},
},
"location": "London",
"attendees": []int{1, 2, 3},
"host": 2,
"meeting": b24.Params{
"notify": true,
"reinvite": false,
"allow_invite": false,
"hide_guests": false,
},
"rrule": b24.Params{
"FREQ": "WEEKLY",
"BYDAY": []string{"MO", "WE"},
"COUNT": 10,
"INTERVAL": 1,
},
"crm_fields": []string{"C_5", "L_11"},
})
if err != nil {
return fmt.Errorf("calendar.event.update: %w", err)
}
var value b24.ID
if err := json.Unmarshal(res.Result, &value); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("result:", value)
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 |
|
time |
Information about the request execution time |
|
Name |
Description |
|
result |
Data of the new series of the recurring event (detailed description) |
|
time |
Information about the request execution time |
result Object
|
Name |
Description |
|
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 mandatory parameter \"ownerId\" is not specified for the method \"calendar.event.update\""
}
Meeting room occupancy errors are returned with HTTP status 200:
{
"error": "CALENDAR_LOCATION_OCCUPANCY_CONFLICT",
"error_description": "The meeting room is occupied at the specified time",
"additional": {
"occupancy": {
"dates": [],
"truncated": false
}
}
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
Empty value |
The mandatory parameter "id" is not specified for the method "calendar.event.update" |
The required parameter |
|
|
Empty value |
The mandatory parameter "ownerId" is not specified for the method "calendar.event.update" |
The required parameter |
|
|
Empty value |
The mandatory parameter "type" is not specified for the method "calendar.event.update" |
The required parameter |
|
|
Empty value |
Invalid parameter value for "name" |
Incorrect data format in the |
|
|
Empty value |
Invalid parameter value for "description" |
Incorrect data format in the |
|
|
Empty value |
Access denied |
Updating events in the specified calendar is prohibited |
|
|
Empty value |
You have specified an invalid calendar section ID or the current user does not have access to it |
An identifier of an inaccessible or non-existent calendar is provided |
|
|
Empty value |
Invalid edit type for recurring event |
An incorrect value for the |
|
|
Empty value |
Event to CRM association list must be an array |
Incorrect data format in the |
|
|
Empty value |
Error while editing event |
Another error |
|
|
Empty value |
Invalid parameter value for "doCheckOccupancy" |
A value other than |
|
|
|
The meeting room is occupied at the specified time |
The meeting room from |
|
|
|
ROOM OCCUPANCY INTERVAL IS INVALID |
The availability of the meeting room from |
|
|
|
The meeting room is currently selected for another event. Try again later or select another one |
Another event is booking the meeting room at this moment. Repeat the request later |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |