Skip to main content
POST
Book an advance desk reservation

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
deviceSipUsername
string
required

SIP credential username of the shared desk being booked.

Required string length: 3 - 128
Pattern: ^[a-zA-Z0-9._-]{3,128}$
startsAt
string<date-time>
required

ISO-8601 inclusive start of the booked window.

endsAt
string<date-time>
required

ISO-8601 exclusive end of the booked window. Must be after startsAt, in the future, and at most 24h after startsAt.

deviceLabelSnapshot
string

Optional human-readable device label for the audit trail.

Maximum string length: 120
notes
string

Optional free-text note shown on the booking calendar.

Maximum string length: 500

Response

Created — the resource was created successfully.

data
object