agenda

Update a calendar event (v2)

Changed on

Partially update an event by its provider event ID. Only provided fields change; sending new times can switch an event between timed and all-day. Requires an Idempotency-Key header. Returns { data: { calendar_event } }.

patch/v2/agenda/calendar/events/{eventId}

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v2/agenda/calendar/events/{eventId}
  • Auth: HTTP bearer

Path parameters

eventIdstring required

Request body

summarystring
descriptionstring
locationstring
account_emailstring
account_provider'GOOGLE' | 'OFFICE365'
start_datetimestring date-time

Event start, ISO 8601 with offset (timed events)

end_datetimestring date-time

Event end, ISO 8601 with offset (timed events)

timezonestring

IANA timezone for the event (e.g. "America/New_York")

start_datestring date

Event start date, YYYY-MM-DD (all-day events)

end_datestring date

Event end date, YYYY-MM-DD, EXCLUSIVE (all-day events; a one-day event on the 10th ends on the 11th)

Response

Successful response

Changes