Skip to main content
PATCH
Update a SIP credential

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

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

Path Parameters

id
string
required

Body

application/json

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.

label
string

Device label, 1-32 characters. Renaming does not change the SIP username, so registered devices keep working.

enabled
boolean

Set false to refuse further registrations and inbound calls without deleting the credential; set true to re-enable it.

extensionNumber
string | null

Internal extension, 2-8 characters of digits, * or #. Send null to remove the extension.

outboundEnabled
boolean

Whether the device may place outbound calls.

outboundCallerIdMode
enum<string>

How the From: number is chosen on outbound calls: fixed, pick_from_owned or inherit_org.

Available options:
fixed,
pick_from_owned,
inherit_org
defaultCallerIdE164
string | null

E.164 caller ID, for example +14155550123. Must be a number your organization owns. Send null to clear it.

outboundDailySpendCapCents
integer | null

Daily outbound spend ceiling in cents (0-100000). Send null to remove the cap.

outboundBlockedCountries
string[] | null

ISO 3166-1 alpha-2 country codes this device may not dial. Send null to allow every destination your organization allows.

concurrentCallCap
integer | null

Maximum simultaneous calls (1-100). Send null to remove the cap.

expiresAt
string | null

ISO 8601 timestamp after which the credential stops authenticating. Send null so it never expires.

dnd
boolean

Do-not-disturb. Inbound calls skip the device while this is true; the change applies to the next call, not just new registrations.

forceCodec
string | null

Pin media to one of PCMU, PCMA, OPUS, G722 or AMR-WB. Send null to negotiate normally.

forceRecordInbound
boolean

Always record inbound calls to this device.

forceRecordOutbound
boolean

Always record outbound calls from this device.

forwardBusyToUsername
string | null

SIP username in the same organization to ring when this device is busy. Send null to stop forwarding.

forwardNoAnswerToUsername
string | null

SIP username in the same organization to ring when this device does not answer. Send null to stop forwarding.

forwardUnavailableToUsername
string | null

SIP username in the same organization to ring when this device is not registered. Send null to stop forwarding.

allowedIpCidrs
string[] | null

Source IP allow-list in CIDR notation, up to 20 entries. Send null to accept registrations from any address.

allowedUserAgent
string | null

Lock the credential to one SIP User-Agent string. Send null to accept any client.

voicemailPin
string | null

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.

notes
string | null

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.