Create Shared Capacity Groups

POST https://{{host}}/v3/shared_capacity_groups

Creates a Shared Capacity Group.

Request Body Scheme

{

data (object, 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 Create

{
  "data": {
    "type": "shared_capacity_groups",
    "attributes": {
      "name": "Sample Capacity Group",
      "metered_channels_count": 5,
      "shared_channels_count": 3
    },
    "relationships": {
      "capacity_pool": {
        "data": {
          "type": "capacity_pools",
          "id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa"
        }
      }
    }
  }
}

---

Create and Assign DIDs

{
  "data": {
    "type": "shared_capacity_groups",
    "attributes": {
      "name": "Sample Capacity Group",
      "metered_channels_count": 5,
      "shared_channels_count": 3
    },
    "relationships": {
      "capacity_pool": {
        "data": {
          "type": "capacity_pools",
          "id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa"
        }
      },
      "dids": {
        "data": [
          {
            "type": "dids",
            "id": "091b6984-07f7-4eca-a42c-f1856248d646"
          },
          {
            "type": "dids",
            "id": "88b0e9a1-5d8e-4737-8f31-43f0b2aa2861"
          }
        ]
      }
    }
  }
}

Request Params

Allowed values:

dids - a list of DID Object

---

capacity_pool - Capacity Pool Object *** |

HEADERS

RESPONSES

status: Created

{"data":{"id":"71afa2e2-8d46-4ea3-988d-aa112ed98b5e","type":"shared_capacity_groups","attributes":{"name":"Sample Capacity 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":"2022-05-10"}}