Sign in

v2

latestOpenAPI 3.1.02026-08-05100545344.4 KB
phoneNumbers

Update a phone number

Updates the configuration of a phone number.

patch/numbers/{phone_number_slug}

Path parameters

phone_number_slugstring required

The phone number slug (phone number without the leading +).

Headers

Authorizationstring required

Bearer authentication

Request body

friendly_namestring

A human-readable name for the phone number.

sip_auth_usernamestring

SIP authentication username.

sip_outbound_proxystring

SIP outbound proxy.

sip_term_uristring

SIP termination URI / SIP domain. Required when changing the SIP domain for providers other than five9, ringcx, and zoom. You may also send termination_uri as an alias; it is mapped to sip_term_uri.

termination_uristring

Alias for sip_term_uri (SIP domain). Required when setting the domain for providers other than five9, ringcx, and zoom.

provider_name'twilio' | 'telnyx' | 'vonage' | 'ring_central' | 'ringcx' | 'custom' | 'zoom' | 'five9'

Telephony provider. When set to a non-auto provider without a SIP domain, the request fails with 400.

trunk_usernamestring

SIP trunk username for authentication. Required when enabling uac_enabled.

trunk_pwdstring

SIP trunk password for authentication. Required when enabling uac_enabled.

uac_enabledboolean

When true, Synthflow sends outbound SIP REGISTER traffic to your carrier or PBX. Requires trunk_username and trunk_pwd when enabling registration.

uac_register_expiresinteger

SIP registration refresh interval in seconds. Whole numbers only, between 60 and 3600. Defaults to 300.

Response

200

statusstring

Whether the request was successful.