UpdatePhoneNumberRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-update-phone-number-request-schema.json",
  "title": "UpdatePhoneNumberRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-phone-number-configurations-api-openapi.yml#/components/schemas/UpdatePhoneNumberRequest",
  "properties": {
    "address_id": {
      "description": "Identifies the address associated with the phone number.",
      "type": "string"
    },
    "billing_group_id": {
      "description": "Identifies the billing group associated with the phone number.",
      "type": "string"
    },
    "connection_id": {
      "description": "Identifies the connection associated with the phone number.",
      "type": "string"
    },
    "customer_reference": {
      "description": "A customer reference string for customer look ups.",
      "type": "string"
    },
    "external_pin": {
      "description": "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.",
      "type": "string"
    },
    "hd_voice_enabled": {
      "description": "Indicates whether HD voice is enabled for this number.",
      "type": "boolean"
    },
    "id": {
      "description": "Identifies the type of resource.",
      "readOnly": true,
      "type": "string"
    },
    "tags": {
      "description": "A list of user-assigned tags to help organize phone numbers.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}