Update Shared Capacity Groups

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

Updates a Shared Capacity Group.

Request Body Scheme

{

data (object, required) {

id (string, required)

type (string, required): : sharedcapacitygroups

attributes (object, required) {

name (string, NOT nullable, required)
Unique name of Shared Capacity Group.

sharedchannelscount (integer, NOT nullable, required)
Unassigned channels quantity to assign to the Shared Capacity Group from the Capacity Pool.

meteredchannelscount (integer, NOT nullable, required)
Metered channels quantity to assign to the Shared Capacity Group.

}

relationships (object, required/optional) {

dids (object, optional): to-many
Linkage for included list of DID Object

capacity_pool (object, required): to-one
Linkage for included Capacity Pool Object

}

}

}

Request Body Example

Simple Update

{
  "data": {
    "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
    "type": "shared_capacity_groups",
    "attributes": {
      "name": "Renamed group"
    }
  }
}

---

Update and Remove DIDs

{
  "data": {
    "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
    "type": "shared_capacity_groups",
    "relationships": {
      "dids": {
        "data": [
        ]
      }
    }
  }
}

Request Params

Allowed values:

dids - a list of DID Object

---

capacity_pool - Capacity Pool Object *** |

HEADERS

RESPONSES

status: OK

{"data":{"id":"71afa2e2-8d46-4ea3-988d-aa112ed98b5e","type":"shared_capacity_groups","attributes":{"name":"Renamed group","shared_channels_count":3,"created_at":"2018-07-06T16:11:32.981Z","metered_channels_count":5},"relationships":{"capacity_pool":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool","related":"https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"}},"dids":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids","related":"https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"}}}},"meta":{"api_version":"2021-12-15"}}