#Calendar events

Entity: calendarEvent | Scope: calendar | Base path: /v1/calendar-events

Legacy entity (UPPER_CASE field names) — field names are automatically converted to camelCase.

#Operations

Method Path Description Bitrix24 Method
GET /v1/calendar-events/:id Get by ID calendar.event.getbyid
POST /v1/calendar-events Create new calendar.event.add
PATCH /v1/calendar-events/:id Update by ID calendar.event.update
DELETE /v1/calendar-events/:id Delete by ID calendar.event.delete

Disabled operations: list

#Fields

API Name Bitrix24 Name Type Readonly Description
id ID number yes Идентификатор записи
name NAME string Название события
description DESCRIPTION string Описание
ownerId OWNER_ID number ID владельца календаря
ownerType OWNER_TYPE string
dateFrom DATE_FROM datetime Дата и время начала
dateTo DATE_TO datetime Дата и время окончания
allDay ALL_DAY boolean
importance IMPORTANCE string Важность (high, normal, low)
accessibility ACCESSIBILITY string
location LOCATION string Место проведения
color COLOR string
sectionId SECTION_ID number

#Examples

#Get by ID

Terminal 
curl -X GET '/v1/calendar-events/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Create

Terminal 
curl -X POST '/v1/calendar-events' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"value","description":"value","ownerId":1}'

#Update

Terminal 
curl -X PATCH '/v1/calendar-events/123' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"updated"}'

#Delete

Terminal 
curl -X DELETE '/v1/calendar-events/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Batch

Terminal 
curl -X POST '/v1/batch' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"calls":[{"entity":"calendar-events","action":"list","params":{"limit":5}}]}'