Phone Number Configurations

Delete a phone number

Deletes the specified phone number from the account. The response contains the phone number's final deleted representation.

delete/phone_numbers/{id}

Path parameters

idstring required
Example:1293384261075731499

Identifies the resource.

Response

Successful response with details about a phone number.

Example response

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

Changes

Changed in 4 of the 61 revisions of this API.20616

  • 1571b0380bd7155See the full diff
    • the response property errors/items/code became optional for the status 400

      response-property-became-optional

    • the response property errors/items/code became optional for the status 401

      response-property-became-optional

    • the response property errors/items/code became optional for the status 404

      response-property-became-optional

    • the response property errors/items/code became optional for the status 422

      response-property-became-optional

    • the response property errors/items/code became optional for the status 500

      response-property-became-optional

    • the response property errors/items/title became optional for the status 400

      response-property-became-optional

    • the response property errors/items/title became optional for the status 401

      response-property-became-optional

    • the response property errors/items/title became optional for the status 404

      response-property-became-optional

    • the response property errors/items/title became optional for the status 422

      response-property-became-optional

    • the response property errors/items/title became optional for the status 500

      response-property-became-optional

    • the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401

      response-property-type-changed

    • the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404

      response-property-type-changed

    • the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      response-property-type-changed

    • added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

    • added the optional property errors/items/meta/url to the response with the 401 status

      response-optional-property-added

    • added the optional property errors/items/meta/url to the response with the 404 status

      response-optional-property-added

    • added the optional property errors/items/meta/url to the response with the 422 status

      response-optional-property-added

    • added the optional property errors/items/meta/url to the response with the 500 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

  • 8f5f4e5379945510See the full diff
    • the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401

      response-property-type-changed

    • the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404

      response-property-type-changed

    • the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

    • removed the optional property errors/items/meta/url from the response with the 401 status

      response-optional-property-removed

    • removed the optional property errors/items/meta/url from the response with the 404 status

      response-optional-property-removed

    • removed the optional property errors/items/meta/url from the response with the 422 status

      response-optional-property-removed

    • removed the optional property errors/items/meta/url from the response with the 500 status

      response-optional-property-removed

    • the response property errors/items/code became required for the status 400

      response-property-became-required

    • the response property errors/items/code became required for the status 401

      response-property-became-required

    • the response property errors/items/code became required for the status 404

      response-property-became-required

    • the response property errors/items/code became required for the status 422

      response-property-became-required

    • the response property errors/items/code became required for the status 500

      response-property-became-required

    • the response property errors/items/title became required for the status 400

      response-property-became-required

    • the response property errors/items/title became required for the status 401

      response-property-became-required

    • the response property errors/items/title became required for the status 404

      response-property-became-required

    • the response property errors/items/title became required for the status 422

      response-property-became-required

    • the response property errors/items/title became required for the status 500

      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

    • added the optional property data/activated_at to the response with the 200 status

      response-optional-property-added

    • removed the optional property data/activated_at from the response with the 200 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