Rotate a SIP credential password
Generates a new password for an existing SIP credential, invalidating the old one immediately. The username remains the same so the credential does not need to be reconfigured in the user agent — only the password field changes. Returns the new plaintext password exactly once. Admin or owner only.
Authorizations
Dashboard JWT token from Clerk
Headers
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.
1 - 255Sandbox 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.
true, false Path Parameters
Response
The credential with the new plaintext password (shown once) and metadata inside the standard { data, meta } envelope.
The credential with the new plaintext password (shown once) and metadata inside the standard { data, meta } envelope.