Sign in
calendar-events

Create recurring event exception

Changed on

Create an exception for a recurring event (either cancelled or modified).

post/calendar-events/{id}/create-exception{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

exception_datestring date required

The date of the occurrence to modify or cancel

modified_titlestring nullable

New title for the modified occurrence (if not cancelled)

modified_descriptionstring nullable

New description for the modified occurrence (if not cancelled)

modified_start_timestring date-time nullable

New start time for the modified occurrence (if not cancelled)

modified_end_timestring date-time nullable

New end time for the modified occurrence (if not cancelled)

is_cancelledboolean

True if cancelling the occurrence, False if modifying

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