Skip to main content
PUT
Upsert one per-agent per-channel concurrency cap

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
agent_user_id
string
required

Workspace user id of the agent the cap applies to (1-128 characters).

Required string length: 1 - 128
channel
enum<string>
required

Channel the cap governs (e.g. sms, whatsapp, email, voice, web_chat).

Available options:
sms,
whatsapp,
email,
rcs,
viber,
instagram,
messenger,
line,
telegram,
agent,
voice,
video,
apple_messages,
web_chat
max_concurrent
integer
required

Maximum simultaneous open interactions on this channel (0-1000). 0 opts the agent out of the channel entirely.

Required range: 0 <= x <= 1000

Response

Successful response.