Create Shared Capacity Groups

Creates a Shared Capacity Group.

Request

HTTP Method: POST

URI Path: /v3/shared_capacity_groups

URI Query Parameters

Name	Type	Is Required?	Description
include	string	No	Inclusion

Request Body Object Attributes

Name	Type	Nullable	Is Required?	Description
name	string	False	Yes	Unique name of Shared Capacity Group.
external_reference_id	string	True	No	Optional identifier for the shared capacity group in the customer’s external system. Maximum length is 100 characters.
shared_channels_count	integer	False	No	Unassigned channels quantity to assign to the Shared Capacity Group from the Capacity Pool.
metered_channels_count	integer	False	No	Metered channels quantity to assign to the Shared Capacity Group.

Request Body Object Relationships

Title	Type	Description
dids	To Many	Linkage for included dids.
capacity_pool	To one	Linkage for included capacity_pool.

Examples

Simple CreateCreate and Assign DIDs

http

POST /v3/shared_capacity_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "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"
        }
      }
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/shared_capacity_groups -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"metered_channels_count": 5, "name": "Sample Capacity Group", "shared_channels_count": 3}, "relationships": {"capacity_pool": {"data": {"id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa", "type": "capacity_pools"}}}, "type": "shared_capacity_groups"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "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",
      "external_reference_id": null,
      "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"
        }
      }
    }
  }
}

Other Responses

Code	Success	Description
422	No	Unprocessable Entity
401	No	Unauthorized