Skip to main content
POST
Hold an offered slot

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Body

application/json
slot_token
string
required

From POST /v1/scheduling/slots/search.

ttl_seconds
integer

Shorter than the policy TTL only; capped.

Required range: x >= 1

Response

Slot held

success
enum<boolean>
Available options:
true
data
object
meta
object