# Update Shared Capacity Groups

Updates a Shared Capacity Group.

## Request

HTTP Method: `PATCH`

URI Path: `/v3/shared_capacity_groups/{id}`

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| id | `string` | Yes | Unique ID number allocated to this Shared Capacity Group. |

### Request Body Object Attributes

| Name | Type | Nullable | Is Required? | Description |
| --- | --- | --- | --- | --- |
| name | `string` | False | No | 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 UpdateUpdate and Assign DIDsUpdate and Remove DIDs

[[DIDWW-API-EXAMPLE-START]]

http

```
 1PATCH /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e 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    "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
10    "type": "shared_capacity_groups",
11    "attributes": {
12      "name": "Renamed group"
13    }
14  }
15}
```

curl

```
1curl -i -X PATCH https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"name": "Renamed group"}, "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e", "type": "shared_capacity_groups"}}'
```

response

```
 1HTTP/1.1 200 OK
 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": "Renamed 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

```
 1PATCH /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e 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    "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
10    "type": "shared_capacity_groups",
11    "relationships": {
12      "dids": {
13        "data": [
14          {
15            "type": "dids",
16            "id": "a2dcccdb-4c81-4d93-a174-26001ccfc13a"
17          },
18          {
19            "type": "dids",
20            "id": "fd345680-4a4e-40db-b2f2-f81651e3e2df"
21          }
22        ]
23      }
24    }
25  }
26}
```

curl

```
1curl -i -X PATCH https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e", "relationships": {"dids": {"data": [{"type": "dids", "id": "a2dcccdb-4c81-4d93-a174-26001ccfc13a"}, {"type": "dids", "id": "fd345680-4a4e-40db-b2f2-f81651e3e2df"}]}}, "type": "shared_capacity_groups"}}'
```

response

```
 1HTTP/1.1 200 OK
 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": "Renamed group",
10      "shared_channels_count": 3,
11      "created_at": "2023-03-28T18:25:38.415Z",
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

```
 1PATCH /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e 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    "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
10    "type": "shared_capacity_groups",
11    "relationships": {
12      "dids": {
13        "data": [
14
15        ]
16      }
17    }
18  }
19}
```

curl

```
1curl -i -X PATCH https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e", "relationships": {"dids": {"data": []}}, "type": "shared_capacity_groups"}}'
```

response

```
 1HTTP/1.1 200 OK
 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": "Renamed 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 |
| --- | --- | --- |
| 404 | No | [Not Found](../../../specification/errors/index.html#api-not-found) |
| 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. |
| 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. |
