Sign in
calendar-events

Bulk modify or cancel recurring event from a date

Changed on

ViewSet for managing calendar events.

post/calendar-events/{id}/bulk-modify{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required
idstring required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Request body

modification_start_datestring date required
modified_titlestring nullable
modified_descriptionstring nullable
rrule_stringstring nullable

RRULE string for the modification range

modified_start_time_offsetstring nullable
modified_end_time_offsetstring nullable
is_cancelledboolean

Response

idinteger required
providerstring
titlestring required
descriptionstring
start_timestring date-time required
end_timestring date-time required
timezonestring required
createdstring date-time required
modifiedstring date-time required
external_idstring required
rrule_stringstring

RRULE string for creating recurring events

parent_recurring_object_idinteger

ID of parent event for recurring instances

is_recurring_instanceboolean required

True if this is an instance of a recurring event

is_recurringboolean required

True if this is a recurring event

is_recurring_exceptionboolean

True if this object is an exception to the recurrence rule (modified occurrence)

recurrence_idstring date-time nullable

For recurring instances, this identifies which occurrence this is

google_calendar_service_accountinteger
calendarinteger

Changes

  • e92afcb6b029Revision changes
    • ▲

      removed the required property from the response with the status

    • ○

      added the required property to the response with the status

  • 722e2911db6eRevision changes
    • ○

      added the required property to the response with the status