Update an event

PUT /api/2.0/calendar/{calendarId}/{eventId}

Request

Updates the existing event in the selected calendar with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Path

calendarIdstring

Calendar ID

eventIdintegerformat: int32

Event ID

Body

namestring

New event name

descriptionstring

New event description

startDatestring

New event start date

endDatestring

New event end date

repeatTypestring

New event repeat type (RRULE string in the iCal format)

alertTypeinteger

New event notification type

isAllDayLongboolean

New event duration type: all day long or not

sharingOptionsarray of object

New event sharing access parameters

statusinteger

New event status

Examples

PUT /api/2.0/calendar/%7BcalendarId%7D/%7BeventId%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url https://example.com/api/2.0/calendar/%7BcalendarId%7D/%7BeventId%7D \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated list of events

Idstring

Uidstring

CalendarIdstring

Namestring

Descriptionstring

AllDayLongboolean

Startstring

Endstring

RepeatRulestring

Alertobject

Typeintegerformat: int32

IsSharedboolean

CanUnsubscribeboolean

IsEditableboolean

Permissionsobject

UserParamsarray of object

Idstringformat: uuid

Namestring

Ownerobject

Idstringformat: uuid

Namestring

Statusenum of integerformat: int32

[0 - Tentative, 1 - Confirmed, 2 - Cancelled]

Can be one of: Tentative, Confirmed, Cancelled.

HasAttachmentsboolean

401

Unauthorized