# Create Shared Capacity Groups

Creates a Shared Capacity Group.

## Request

HTTP Method: `POST`

URI Path: `/v3/shared_capacity_groups`

### 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](../../../specification/relationships.html#api-relationships) | Linkage for included dids. |
| capacity\_pool | [To one](../../../specification/relationships.html#api-relationships) | Linkage for included capacity\_pool. |

## Examples

Simple CreateCreate and Assign DIDs

[[DIDWW-API-EXAMPLE-START]]

http

```
 1POST /v3/shared_capacity_groups HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Authorization: Bearer [access token]
 6
 7{
 8  "data": {
 9    "type": "shared_capacity_groups",
10    "attributes": {
11      "name": "Sample Capacity Group",
12      "metered_channels_count": 5,
13      "shared_channels_count": 3
14    },
15    "relationships": {
16      "capacity_pool": {
17        "data": {
18          "type": "capacity_pools",
19          "id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa"
20        }
21      }
22    }
23  }
24}
```

curl

```
1curl -i -X POST https://api.didww.com/v3/shared_capacity_groups -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --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

```
 1HTTP/1.1 201 Created
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
 7    "type": "shared_capacity_groups",
 8    "attributes": {
 9      "name": "Sample Capacity Group",
10      "shared_channels_count": 3,
11      "created_at": "2018-07-06T16:11:32.981Z",
12      "external_reference_id": null,
13      "metered_channels_count": 5
14    },
15    "relationships": {
16      "capacity_pool": {
17        "links": {
18          "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
19          "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
20        }
21      },
22      "dids": {
23        "links": {
24          "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
25          "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
26        }
27      }
28    }
29  },
30  "meta": {
31    "api_version": "2026-11-19"
32  }
33}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
 1POST /v3/shared_capacity_groups HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Authorization: Bearer [access token]
 6
 7{
 8  "data": {
 9    "type": "shared_capacity_groups",
10    "attributes": {
11      "name": "Sample Capacity Group",
12      "metered_channels_count": 5,
13      "shared_channels_count": 3
14    },
15    "relationships": {
16      "capacity_pool": {
17        "data": {
18          "type": "capacity_pools",
19          "id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa"
20        }
21      },
22      "dids": {
23        "data": [
24          {
25            "type": "dids",
26            "id": "091b6984-07f7-4eca-a42c-f1856248d646"
27          },
28          {
29            "type": "dids",
30            "id": "88b0e9a1-5d8e-4737-8f31-43f0b2aa2861"
31          }
32        ]
33      }
34    }
35  }
36}
```

curl

```
1curl -i -X POST https://api.didww.com/v3/shared_capacity_groups -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --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"}}, "dids": {"data": [{"type": "dids", "id": "091b6984-07f7-4eca-a42c-f1856248d646"}, {"type": "dids", "id": "88b0e9a1-5d8e-4737-8f31-43f0b2aa2861"}]}}, "type": "shared_capacity_groups"}}'
```

response

```
 1HTTP/1.1 201 Created
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
 7    "type": "shared_capacity_groups",
 8    "attributes": {
 9      "name": "Sample Capacity Group",
10      "shared_channels_count": 3,
11      "created_at": "2018-07-06T16:11:32.981Z",
12      "external_reference_id": null,
13      "metered_channels_count": 5
14    },
15    "relationships": {
16      "capacity_pool": {
17        "links": {
18          "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
19          "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
20        }
21      },
22      "dids": {
23        "links": {
24          "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
25          "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
26        }
27      }
28    }
29  },
30  "meta": {
31    "api_version": "2026-11-19"
32  }
33}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 422 | No | [Unprocessable Entity](../../../specification/errors/index.html#api-validation-error-object) |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request). The body carries a member the API does not accept. Also returned with the title `Quota limit reached` when the account has reached its limit of shared capacity groups. |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 403 | No | The customer is in read-only mode. Also returned when the access token carries the `read` scope, which does not cover this method (title `Insufficient scope`, `WWW-Authenticate: Bearer error="insufficient_scope"`). See [Scopes](../../authentication.html#authentication-scopes-v35). |
| 429 | No | The request budget of the account for the current window is spent (`too_many_requests`). `Retry-After` gives the number of seconds to wait. |
