Skip to main content
PATCH
Set your recurring DND schedule

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. 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
enabled
boolean
required

When false the schedule stays persisted but never fires; re-send the full envelope with false to turn the schedule off.

Example:

true

timezone
string
required

IANA timezone name, e.g. "Europe/Paris".

Example:

"Europe/Paris"

daysOfWeek
integer[]
required

Days the window applies to (0-6, Sunday=0). Deduplicated and sorted before persistence.

Required range: 0 <= x <= 6
Example:
startMinute
integer
required

Window start, minutes since 00:00 local (0-1439).

Required range: 0 <= x <= 1439
Example:

540

endMinute
integer
required

Window end, minutes since 00:00 local (0-1440; 1440 is the end-of-day sentinel).

Required range: 0 <= x <= 1440
Example:

1020

Response

The caller's DND schedule after the update.

The caller's DND schedule after the update.

data
object

The caller's own recurring weekly DND schedule as persisted.

meta
object