Skip to main content
PUT
Update a phone number

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

The phone number record id.

Body

application/json
label
string
Maximum string length: 100
status
enum<string>
Available options:
active,
inactive
capabilities
enum<string>[]
Available options:
sms,
mms,
voice,
fax
forwarding_number
string

E.164 number to forward inbound calls to, or an empty string to clear.

webhook_url
string | null

HTTPS inbound-event webhook for this DID, or null to clear.

sms_forwarding
string

E.164 number to forward inbound SMS to, or an empty string to clear.

compliance_profile_id
string | null

Tenant compliance-profile id to attach, or an empty string / null to detach.

messaging_mps_cap
integer | null

Per-DID outbound messages-per-second ceiling, or null to clear.

Required range: 1 <= x <= 1000
monthly_spend_cap_cents
integer | null

Per-DID monthly outbound SMS spend ceiling in US cents, or null to clear.

Required range: 1 <= x <= 100000000
tags
string[]
Maximum array length: 10

Response

The updated phone number record.

data
object
meta
object