Skip to main content
PATCH
Update an availability schedule rule

Uso

Usalo dentro de Bookable Payments para modelar inventario reservado, calcular disponibilidad, crear holds, convertirlos en checkout y confirmar bookings.

Antes de llamar

Patron recomendado

  • Ejecuta este endpoint desde backend o job seguro, nunca desde frontend con API keys.
  • Manda Idempotency-Key cuando el endpoint cree, convierta, reprograme, cancele, capture o reembolse estado.
  • Confirma inventario final con booking.confirmed o una lectura de booking, no solo con una URL de retorno.
  • Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.

Ejemplo minimo

terminal

Errores a manejar

  • 400 indica payload, parametros o estado invalido.
  • 401 o 403 indican API key, ambiente o scopes incorrectos.
  • 409 suele indicar conflicto de estado, duplicado o idempotencia incompatible.
  • 404 significa que el recurso no existe para ese tenant o ambiente.
  • 429 y 5xx se pueden reintentar con backoff; en writes conserva la misma idempotency key.

Contrato OpenAPI

El playground, parametros, body y respuestas de abajo salen de /openapi.json. Si el contrato cambia, actualiza la spec y regenera esta pagina.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required
Required string length: 8 - 255

Path Parameters

id
string<uuid>
required
rule_id
string<uuid>
required

Body

application/json
active
boolean
capacity
integer | null
Required range: x >= 1
end_time
string
Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$
metadata
object
start_time
string
Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$
weekday
integer
Required range: 0 <= x <= 6

Response

200 - application/json

Availability rule updated

active
boolean
capacity
integer
Required range: x >= 1
endTime
string
id
string<uuid>
metadata
object
object
any
scheduleId
string<uuid>
startTime
string
updatedAt
string<date-time>
weekday
integer
Required range: 0 <= x <= 6
Last modified on June 21, 2026