Sign in
available-times

Create recurring available time exception

Changed on

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

post/available-times/{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_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
start_timestring date-time required
end_timestring date-time required
timezonestring required
rrule_stringstring

RRULE string for creating recurring available times

is_recurring_instanceboolean required

True if this is an instance of a recurring available time

is_recurringboolean required

True if this is a recurring available time

recurrence_idstring date-time nullable required

For recurring instances, this identifies which occurrence this is

createdstring date-time required
modifiedstring date-time required
calendarinteger nullable

Changes

  • 193c4a0f6c85Revision changes
    • ○

      added to the ///// response property allOf list for the response status

    • ○

      removed from the ///// response property allOf list for the response status

  • 8e69e8419131Revision changes
    • ○

      added to the ///// response property allOf list for the response status

    • ○

      removed from the ///// response property allOf list for the response status