Access Tokens1

Addresses6

Advanced Number Orders4

AI Collections14

Anthropic Messages1

Assistants46

Audio1

Audit Logs1

Authentication Providers5

AutoRechargePreferences2

Billing1

Billing Groups5

Bot Signup4

Brands16

Bucket SSL Certificate3

Bucket Usage2

Bulk Phone Number Campaigns3

Bulk Phone Number Operations5

Bundles2

Call Commands42

Call Control Applications5

Call Information2

Call Recordings11

Campaign15

CDR Reports10

CDR Usage Reports9

Chat4

cloudfs filesystems6

Clusters5

Comments2

Conference Commands23

Connections3

Contents1

Conversation Histories1

Conversations21

Country Coverage2

Coverage1

Credential Connections6

Credentials5

CSV Downloads3

Customer Service Record4

Data Migration9

Debugging1

Decision Models1

Detail Records1

Dialogflow Integration4

DIR References3

Display Identity Records8

Documents8

Dynamic Emergency Addresses4

Dynamic Emergency Endpoints4

Email Domain DNS Records2

Email Domains7

Email Drafts8

Email Events2

Email Inboxes19

Email Messages11

Email Suppression Imports2

Email Suppressions6

Email Templates7

Email Threads2

Email Unsubscribe Groups8

Email Validations3

Email Verification3

Email Webhooks5

Embeddings8

Enterprises6

Enum1

External Connections23

Fine Tuning4

FQDN Connections7

FQDNs5

functions7

Global IPs21

Hosted Numbers9

Inexplicit Number Orders3

Infringement Claims4

Integration Secrets3

Integrations5

Inventory Level1

IP Addresses4

IP Connections5

IP Ranges3

IPs5

kv keys4

kv namespaces4

Machine Payments1

Managed Accounts8

MCP Servers5

MDR Detail Reports1

MDR Detailed Reports8

MDR Usage Reports13

Media Storage API6

Meeting Session Actions3

Meeting Session Artifacts3

Meeting Session Data4

Meeting Sessions5

Memory4

Messages11

Messaging15

Messaging URL Domains1

Missions41

Mobile Network Operators1

Mobile Number Settings2

Mobile Phone Numbers3

Mobile Voice Connections5

Networks9

Noise Suppression Engines1

Notifications16

Number Lookup1

Number Portout14

Number Settings7

numbers features1

OAuth Clients10

OAuth Discovery2

OAuth Grants6

OAuth Protocol7

OpenAI Chat3

OpenAI Embeddings2

Operations1

Opt-Out Management6

Organization Users4

OTA updates2

Outbound Voice Profiles5

Phone Number Batches2

Phone Number Block Orders3

Phone Number Blocks Background Jobs3

Phone Number Campaigns5

Phone Number Configurations11

Phone Number Orders21

Phone Number Porting1

Phone Number Reservations4

Phone Number Search2

Phone Numbers3

Porting Orders53

Presigned Object URLs1

Pricing2

Private Wireless Gateways4

Profiles11

Programmable Fax Applications5

Programmable Fax Commands6

Pronunciation Dictionaries5

Public Internet Gateways4

Push Credentials4

Queue Commands9

RCS9

RCS Agents10

RCS Brands5

Reference Data3

Regions1

Regulatory Requirements3

Reporting8

Reports2

Reputation17

Requirement Groups10

Requirement Types2

Requirements4

Research2

Room Compositions4

Room Participants2

Room Recordings4

Room Sessions7

Rooms6

Rooms Client Tokens2

Session Analysis3

SETI Observability1

Settings2

Shared Campaigns5

Short Codes3

SIM Card Actions4

SIM Card Group Actions2

SIM Card Groups9

SIM Card Orders4

SIM Cards26

SIPREC Connectors4

Sources3

Speech to Text Batch Reports8

Speech To Text Capabilities1

Speech To Text over WebSockets1

Speech to text Usage Reports2

sql databases5

Stored Payment Transactions1

Telco Data Usage Reports8

Terms of Service6

TeXML Applications5

TeXML REST Commands35

Text To Speech Commands3

Traffic Policy Profiles12

UAC Connections6

Usage Reports (BETA)2

User Bundles6

User Tags1

UserAddresses6

Verification Requests7

Verified Numbers5

Verify16

Virtual Cross Connects7

Voice Channels6

Voice Clones6

Voice Designs7

Voice SDK Stats2

Voicemail3

WDR Detail Reports1

Web Search1

Webhooks2

Whatsapp Business Accounts14

Whatsapp Message Templates10

Whatsapp messaging1

Whatsapp Phone Numbers32

WireGuard Interfaces10

Wireless Blocklists6

Wireless Regions1

x402 Payment Transactions4

Webhooks

Callbacks91

Meeting Session Webhooks5

Phone Number Configurations

Update a phone number

Updates the configurable settings of the specified phone number. The response contains the complete updated phone-number representation.

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"
  }
}

Changes

Changed in 6 of the 99 revisions of this API.251127

Sep 24, 202696654ba6a1b11See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 16, 2026a6a61a29ecdd5510See the full diff
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 17, 20261571b0380bd7155See the full diff
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the // response's property type changed from integer to string, and format from int32 to no format for status
  response-property-type-changed
- ▲
  the // response's property type changed from integer to string, and format from int32 to no format for status
  response-property-type-changed
- ▲
  the // response's property type changed from integer to string, and format from int32 to no format for status
  response-property-type-changed
- ▲
  the // response's property type changed from integer to string, and format from int32 to no format for status
  response-property-type-changed
- ▲
  the // response's property type changed from integer to string, and format from int32 to no format for status
  response-property-type-changed
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 20268f5f4e5379945510See the full diff
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ▲
  the // response's property type changed from string to integer, and format from no format to int32 for status
  response-property-type-changed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 2026b1f7c46528b51See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jul 2, 2026224ed0d8a5c31See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
This revision also has 111 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.

Full history