Update Shared Capacity Groups#

Description

Updates a Shared Capacity Group.

Request#

HTTP Method: PATCH

URI Path: /v3/shared_capacity_groups/

URI Query Parameters:

Name

Type

Is Required?

Description

include

string

Optional

Inclusion

Request Body Object Attributes:

Name

Type

Nullable

Is Required?

Description

name

string

False

Yes

Unique name of Shared Capacity Group.

shared_channels_count

integer

False

Yes

Unassigned channels quantity to assign to the Shared Capacity Group from the Capacity Pool.

metered_channels_count

integer

False

Yes

Metered channels quantity to assign to the Shared Capacity Group.

Request Body Object Relationships:

Titile

Type

Description

dids

To Many | Linkage for included dids.

capacity_pool

To one | Linkage for included capacity_pool.

Examples#

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
 5Api-Key: [API 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 "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"name": "Renamed group"}, "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e", "type": "shared_capacity_groups"}}'

response

 1HTTP/1.1 201 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            "metered_channels_count": 5
13        },
14        "relationships": {
15            "capacity_pool": {
16                "links": {
17                    "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
18                    "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
19                }
20            },
21            "dids": {
22                "links": {
23                    "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
24                    "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
25                }
26            }
27        }
28    },
29  "meta": {
30    "api_version": "2017-09-18"
31  }
32}

Other Responses#

Code

Success

Description

422

No

Unprocessable Entity

401

No

Unauthorized