Search docs ⌘K
esc
Type to search across all documentation pages
Booking

Blockers

Create time blockers to prevent bookings during specific periods, such as holidays, maintenance windows, or staff breaks.

Create a blocker

POST
/modules/booking/blockers
booking:write

Block a time range on a resource.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/booking/blockers \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"resource_id":"...","start_time":{},"end_time":{}}'
json — 201 Created
{ "status": "ok" }
Body field
Type
Description
resource_id required
string
title
string
max 500 chars
start_time required
string (ISO 8601)
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
end_time required
string (ISO 8601)
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
all_day
boolean
recurrence
object
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

List blockers

GET
/modules/booking/blockers
booking:read

List time blockers.

curl
curl https://api.saasignal.saastemly.com/modules/booking/blockers \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Query param
Type
Description
resource_id
string
from
string (ISO 8601)
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
to
string (ISO 8601)
pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
limit
integer
range ≥1 .. ≤100default 25
cursor
string
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Delete a blocker

DELETE
/modules/booking/blockers/{blocker_id}
booking:write

Remove a time blocker.

curl
curl -X DELETE https://api.saasignal.saastemly.com/modules/booking/blockers/{blocker_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
blocker_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited