Update a SIP credential
Modifies settings on an existing SIP credential — for example to enable/disable it, set call limits, configure call forwarding, or manage voicemail PIN. Username is immutable. Password is rotated separately via the /rotate endpoint. Send only the fields you wish to change; omitted fields are left untouched. Admin or owner only.
Authorizations
Dashboard JWT token from Clerk
Headers
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.
true, false Path Parameters
Body
The fields to change — at least one is required. Omit a field to leave it untouched; send null on a nullable field to clear it. The on/off flags take true or false only. username cannot be changed (it would break every registered device) and the password is replaced through the rotate endpoint, not here.
The fields to change — at least one is required. Omit a field to leave it untouched; send null on a nullable field to clear it. The on/off flags take true or false only. username cannot be changed (it would break every registered device) and the password is replaced through the rotate endpoint, not here.
Device label, 1-32 characters. Renaming does not change the SIP username, so registered devices keep working.
Set false to refuse further registrations and inbound calls without deleting the credential; set true to re-enable it.
Internal extension, 2-8 characters of digits, * or #. Send null to remove the extension.
Whether the device may place outbound calls.
How the From: number is chosen on outbound calls: fixed, pick_from_owned or inherit_org.
fixed, pick_from_owned, inherit_org E.164 caller ID, for example +14155550123. Must be a number your organization owns. Send null to clear it.
Daily outbound spend ceiling in cents (0-100000). Send null to remove the cap.
ISO 3166-1 alpha-2 country codes this device may not dial. Send null to allow every destination your organization allows.
Maximum simultaneous calls (1-100). Send null to remove the cap.
ISO 8601 timestamp after which the credential stops authenticating. Send null so it never expires.
Do-not-disturb. Inbound calls skip the device while this is true; the change applies to the next call, not just new registrations.
Pin media to one of PCMU, PCMA, OPUS, G722 or AMR-WB. Send null to negotiate normally.
Always record inbound calls to this device.
Always record outbound calls from this device.
SIP username in the same organization to ring when this device is busy. Send null to stop forwarding.
SIP username in the same organization to ring when this device does not answer. Send null to stop forwarding.
SIP username in the same organization to ring when this device is not registered. Send null to stop forwarding.
Source IP allow-list in CIDR notation, up to 20 entries. Send null to accept registrations from any address.
Lock the credential to one SIP User-Agent string. Send null to accept any client.
4-8 digit passcode for the *97 voicemail dial-in. Send a new value to rotate it, or null to remove it. Stored hashed and never returned.
Free-text note, up to 1000 characters. Send null to clear it.
Response
The updated credential object with all fields and metadata inside the standard { data, meta } envelope.
The updated credential object with all fields and metadata inside the standard { data, meta } envelope.