Skip to main content
POST
Create a time-of-day schedule route

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

Path Parameters

id
string
required

Queue config id.

Minimum string length: 1

Body

application/json

endMinutesLocal MUST be greater than startMinutesLocal. Cross-midnight windows (e.g. 22:00→06:00) are TWO rows on consecutive days.

endMinutesLocal MUST be greater than startMinutesLocal. Cross-midnight windows (e.g. 22:00→06:00) are TWO rows on consecutive days.

dayOfWeek
integer
required
Required range: 0 <= x <= 6
startMinutesLocal
integer
required
Required range: 0 <= x <= 1439
endMinutesLocal
integer
required
Required range: 1 <= x <= 1440
targetQueueId
string
required
Required string length: 1 - 120
timezone
string

IANA timezone. Defaults to UTC. An unknown zone returns 400.

Maximum string length: 64
priority
integer
Required range: 0 <= x <= 100000

Response

Created — the resource was created successfully.

data
object
required
meta
object
required