Patch a channel zone

PATCH 
/channel_zones/:channel_zone_id

Change the amount of reserved channels at a given channel zone

Path Parameters

channel_zone_id stringrequired

Channel zone identifier

application/json

Body

required

Quantity of reserved channels

channels int64

200: Successfuly patched channel zone

application/json

• Schema
• Example (from schema)

Schema

record_type stringrequired

Possible values: [channel_zone]

countries string[]required

List of countries (in ISO 3166-2, capitalized) members of the billing channel zone

id stringrequired
name stringrequired
channels int64required
created_at string

ISO 8601 formatted date of when the channel zone was created

updated_at string

ISO 8601 formatted date of when the channel zone was updated

{
  "record_type": "channel_zone",
  "countries": [
    "BE",
    "EL",
    "LT",
    "PT",
    "BG",
    "ES",
    "LU",
    "RO",
    "CZ",
    "FR",
    "HU",
    "SI",
    "DK",
    "HR",
    "MT",
    "SK",
    "DE",
    "IT",
    "NL",
    "FI",
    "EE",
    "CY",
    "AT",
    "SE",
    "IE",
    "LV",
    "PL"
  ],
  "id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
  "name": "Euro channel zone",
  "channels": 7,
  "created_at": "2019-01-23T18:10:02.574Z",
  "updated_at": "2019-01-23T18:10:02.574Z"
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L -X PATCH 'https://api.telnyx.com/v2/phone_numbers/channel_zones/:channel_zone_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "channels": 0
}'

Response samples

• 200
• default

---

{
  "record_type": "channel_zone",
  "countries": [
    "BE",
    "EL",
    "LT",
    "PT",
    "BG",
    "ES",
    "LU",
    "RO",
    "CZ",
    "FR",
    "HU",
    "SI",
    "DK",
    "HR",
    "MT",
    "SK",
    "DE",
    "IT",
    "NL",
    "FI",
    "EE",
    "CY",
    "AT",
    "SE",
    "IE",
    "LV",
    "PL"
  ],
  "id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
  "name": "Euro channel zone",
  "channels": 7,
  "created_at": "2019-01-23T18:10:02.574Z",
  "updated_at": "2019-01-23T18:10:02.574Z"
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}