Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The phone number to update.

Body

application/json

The new configuration to set for this phone number.

To avoid modifying a value, either omit the field or set its value to null.

messaging_profile_id
string

Configure the messaging profile this phone number is assigned to:

  • Omit this field or set its value to null to keep the current value.
  • Set this field to "" to unassign the number from its messaging profile
  • Set this field to a quoted UUID of a messaging profile to assign this number to that messaging profile
messaging_product
string

Configure the messaging product for this number:

  • Omit this field or set its value to null to keep the current value.
  • Set this field to a quoted product ID to set this phone number to that product
Example:

"P2P"

tags
string[]

Tags to set on this phone number.

Response

Successful response with details about a phone number including messaging settings.

data
object
Example: