Skip to main content
PUT
Update automation ROI assumptions

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_cost_per_hour_cents
integer

Human agent cost per hour, integer cents.

automation_cost_per_contact_cents
integer

Automation cost per handled contact, integer cents.

target_deflection_rate
number

Target deflection rate as a fraction between 0 and 1.

default_aht_seconds
integer

Default average handle time in seconds used when no measured value exists.

min_volume
integer

Minimum monthly contact volume a reason needs to qualify as an opportunity.

Response

The merged, persisted ROI assumptions, in the standard { data, meta } envelope.

The merged, persisted ROI assumptions, in the standard { data, meta } envelope.