Sign in
blocked-times

Changed on

ViewSet for managing blocked times with recurring support.

patch/blocked-times/{id}/

Request

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

Path parameters

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

idinteger
start_timestring date-time
end_timestring date-time
timezonestring
reasonstring
rrule_stringstring

RRULE string for creating recurring blocked times

external_idstring
is_recurring_instanceboolean

True if this is an instance of a recurring blocked time

is_recurringboolean

True if this is a recurring blocked time

createdstring date-time
modifiedstring date-time
calendarinteger nullable

Response

idinteger required
start_timestring date-time required
end_timestring date-time required
timezonestring required
reasonstring
rrule_stringstring

RRULE string for creating recurring blocked times

external_idstring required
is_recurring_instanceboolean required

True if this is an instance of a recurring blocked time

is_recurringboolean required

True if this is a recurring blocked time

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

Changes

  • 193c4a0f6c85Revision changes
    • ▲

      added to the ///// request property allOf list (media type: application/json)

    • ▲

      added to the ///// request property allOf list (media type: application/x-www-form-urlencoded)

    • ▲

      added to the ///// request property allOf list (media type: multipart/form-data)

    • ●

      removed from the ///// request property allOf list (media type: application/json)

    • ●

      removed from the ///// request property allOf list (media type: application/x-www-form-urlencoded)

    • ●

      removed from the ///// request property allOf list (media type: multipart/form-data)

    • ○

      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 ///// request property allOf list (media type: application/json)

    • ▲

      added to the ///// request property allOf list (media type: application/x-www-form-urlencoded)

    • ▲

      added to the ///// request property allOf list (media type: multipart/form-data)

    • ●

      removed from the ///// request property allOf list (media type: application/json)

    • ●

      removed from the ///// request property allOf list (media type: application/x-www-form-urlencoded)

    • ●

      removed from the ///// request property allOf list (media type: multipart/form-data)

    • ○

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

    • ○

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