Update Trunk Group

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

Updates a Trunk Group.

Request Body Scheme

{

data (object, required) {

id (string, required)
Unique ID identifier of Trunk.

type (string, required): trunk_groups

attributes (object, optional) {

name (string, NOT nullable, optional)
Unique name of the Trunk Group.

capacity_limit (integer, NOT nullable, optional)
Maximum number of simultaneous calls for the Trunk Group.

}

relationships (object, optional) {

trunks (object, optional): to-many
Linkage for included list of Trunk Objects

}

}

}

Request Body Example

Simple Update

{
  "data": {
    "id": "43deb3aa-674a-465e-ac16-fb3084325ec7",
    "type": "trunk_groups",
    "attributes": {
      "name": "Renamed group",
      "capacity_limit": 1
    }
  }
}

---

Remove Trunks from the Group

{
  "data": {
    "id": "e74fcf6a-bb8d-4ee0-9980-bdc24a728b9a",
    "type": "trunk_groups",
    "relationships": {
      "trunks": {
        "data": [
        ]
      }
    }
  }
}

Request Params

HEADERS

RESPONSES

status: OK

{"data":{"id":"e74fcf6a-bb8d-4ee0-9980-bdc24a728b9a","type":"trunk_groups","links":{"self":"https://api.didww.com/v3/trunk_groups/e74fcf6a-bb8d-4ee0-9980-bdc24a728b9a"},"attributes":{"created_at":"2017-06-25T14:56:31.513Z","name":"Common Group","capacity_limit":69},"relationships":{"trunks":{"links":{"self":"https://api.didww.com/v3/trunk_groups/e74fcf6a-bb8d-4ee0-9980-bdc24a728b9a/relationships/trunks","related":"https://api.didww.com/v3/trunk_groups/e74fcf6a-bb8d-4ee0-9980-bdc24a728b9a/trunks"}}},"meta":{"trunks_count":0}},"meta":{"api_version":"2017-09-18"}}