Skip to main content
POST
Check schedule conflicts for an audience

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
scheduled_at
string<date-time>
required

Candidate send time to check.

channel
string
required

Campaign channel to check.

audience_type
enum<string>

Audience strategy. Defaults to all.

Available options:
all,
list,
segment,
csv,
manual
audience_id
string

List or segment id when the audience type needs one.

window_hours
integer

Lookaround band in hours (default 72, max 720).

exclude_campaign_id
string

Campaign to ignore — pass its id when editing so it does not conflict with itself.

Response

Conflicting campaigns; conflict_count=0 means the slot is clean.

Conflicting campaigns; conflict_count=0 means the slot is clean.

data
object
meta
object