Update Capacity Pool

PATCH https://{{host}}/v3/capacity_pools/:id

Allows to update the existing Capacity Pool. By using this endpoint it is possible to remove Unassigned Channels from the Capacity Pool.

Request Body Scheme

{

data (object, required) {

id (string, required)
Unique ID identifier of Capacity Pool.

type (string, required): capacity_pools

attributes (object, optional) {

totalchannelscount (integer, NOT nullable optional)
Total number of channels in the Capacity Pool.

}

}

}

Request Body Example

{
  "data": {
    "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
    "type": "capacity_pools",
    "attributes": {
      "total_channels_count": 8
    }
  }
}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":{"id":"b8db1d7c-f415-4530-a340-c774bcc1c55f","type":"capacity_pools","attributes":{"name":"Extended","renew_date":"2018-07-21","total_channels_count":8,"assigned_channels_count":7,"minimum_limit":5,"minimum_qty_per_order":1,"setup_price":"25.0","monthly_price":"25.0","metered_rate":"0.02"},"relationships":{"countries":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"}},"shared_capacity_groups":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"}},"qty_based_pricings":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"}}}},"meta":{"api_version":"2021-04-19"}}