Booking Policies

Update a booking policy

Changed on

Update the rule fields (lead_time_seconds, max_horizon_seconds, buffer_before_seconds, buffer_after_seconds) of an existing booking policy. Target fields (calendar, membership_user_id, appointment type, is_organization_default) are immutable after creation.

put/booking-policies/{id}{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

idinteger required
calendarinteger nullable
appointment_typeinteger nullable
membership_user_idinteger nullable
is_organization_defaultboolean
lead_time_secondsinteger
max_horizon_secondsinteger
buffer_before_secondsinteger
buffer_after_secondsinteger
createdstring date-time required
modifiedstring date-time required

Response

idinteger required
calendarinteger nullable
appointment_typeinteger nullable
membership_user_idinteger nullable
is_organization_defaultboolean
lead_time_secondsinteger
max_horizon_secondsinteger
buffer_before_secondsinteger
buffer_after_secondsinteger
createdstring date-time required
modifiedstring date-time required

Changes

    • ●

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

    • ●

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

    • ●

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

    • ●

      removed the optional property from the response with the status

    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)

    • ○

      added the optional property to the response with the status

    • ○

      endpoint added