Update Branded Phone Number

API Details

  • This endpoint updates existing phone numbers in your account.
  • Accepts partial requests. All body params are optional and can be updated except phoneNumber (the identifier for the resource). Body params specified in the request are updated; omitted params are left unchanged.
  • If a phone number was rejected (optIn.rejected) in error and you want to resubmit for branding or spam remediation, sending true for a carrier feature while in the optIn.rejected status does not update the status. You must first send a request with false for the carrier feature, then send another request with true for the carrier feature.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Path Params
string
required

E.164-formatted phone number to update.

Body Params
string

UUID of the business profile to associate with this phone number

string

Internal name for this phone number (not shown to customers)

string

Short branding name (max 15 characters) to display for this phone number

string

Long branding name (max 32 characters) to display for this phone number

string

Reporting group this phone number belongs to (e.g., sales-team, support)

carrierFeatures
array of objects

Array of carrier configurations specifying which features to enable for each carrier. Only specified carriers/features will be updated.

carrierFeatures
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json