Skip to main content

Update a phone number

PATCH 
/external_connections/:id/phone_numbers/:phone_number_id

Asynchronously update settings of the phone number associated with the given external connection.

Request​

Path Parameters

    id int64required

    Identifies the resource.

    phone_number_id stringrequired

    A phone number's ID via the Telnyx API

Body

required

Values that can be set when updating a phone number

    location_id uuid

    Identifies the location to assign the phone number to.

Responses​

200: Successful response

Schema

    data

    object

    ticket_id uuid

    Uniquely identifies the resource.

    telephone_number string

    Phone number in E164 format.

    number_id string

    Phone number ID from the Telnyx API.

    civic_address_id uuid

    Identifies the civic address assigned to the phone number.

    location_id uuid

    Identifies the location assigned to the phone number.

    displayed_country_code string

    The iso country code that will be displayed to the user when they receive a call from this phone number.

    acquired_capabilities string[]

    Possible values: [FirstPartyAppAssignment, InboundCalling, Office365, OutboundCalling, UserAssignment]

401: Unauthorized

404: Not found

422: Bad request

Request samples

curl -L -X PATCH 'https://api.telnyx.com/v2/external_connections/:id/phone_numbers/:phone_number_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response samples

{
  "data": {
    "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
    "telephone_number": "string",
    "number_id": "string",
    "civic_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayed_country_code": "string",
    "acquired_capabilities": [
      "FirstPartyAppAssignment"
    ]
  }
}