Sign in

v55

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-051,2852,0364.4 MB
Phone Number Configurations

Update a phone number

patch/phone_numbers/{id}

Path parameters

idstring required
Example:1293384261075731499

Identifies the resource.

Request body

idstring

Identifies the type of resource.

tagsstring[]

A list of user-assigned tags to help organize phone numbers.

external_pinstring

If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.

hd_voice_enabledboolean

Indicates whether HD voice is enabled for this number.

customer_referencestring

A customer reference string for customer look ups.

address_idstring

Identifies the address associated with the phone number.

connection_idstring

Identifies the connection associated with the phone number.

billing_group_idstring

Identifies the billing group associated with the phone number.

Example request

{
  "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
  "tags": [
    "tag"
  ],
  "address_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
  "external_pin": "1234",
  "customer_reference": "customer-reference",
  "connection_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
  "billing_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
  "hd_voice_enabled": true
}

Response

Successful response with details about a phone number.

Example response

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "phone_number",
    "phone_number": "+19705555098",
    "country_iso_alpha2": "US",
    "status": "active",
    "tags": [
      "tag_1",
      "tag_2"
    ],
    "external_pin": "1234",
    "connection_id": "1293384261075731499",
    "connection_name": "connection-name",
    "customer_reference": "customer-reference",
    "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
    "messaging_profile_name": "regional-customers",
    "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
    "emergency_enabled": true,
    "emergency_address_id": "1315261609962112019",
    "emergency_status": "active",
    "call_forwarding_enabled": true,
    "cnam_listing_enabled": true,
    "caller_id_name_enabled": true,
    "call_recording_enabled": true,
    "t38_fax_gateway_enabled": true,
    "phone_number_type": "local",
    "inbound_call_screening": "disabled",
    "purchased_at": "2019-10-23T18:10:00.000Z",
    "created_at": "2019-10-23T18:10:00.000Z",
    "updated_at": "2019-10-24T18:10:00.000Z",
    "hd_voice_enabled": true,
    "source_type": "number_order",
    "deletion_lock_enabled": false,
    "activated_at": "2019-10-23T18:10:00.000Z"
  }
}