Delete Shared Capacity Group#

Deletes a Shared Capacity Group.

The request is rejected with 422 while any DID is assigned to the group. Remove those DIDs from the group first, through the dids relationship of Update Shared Capacity Group or the shared_capacity_group relationship of the DID.

Request#

HTTP Method: DELETE

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.

Example#

http

1DELETE /v3/shared_capacity_groups/1156df17-bcea-4c9a-9c1d-29320e288c03 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]

curl

1curl -i -X DELETE https://api.didww.com/v3/shared_capacity_groups/1156df17-bcea-4c9a-9c1d-29320e288c03 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

response

1HTTP/1.1 204 No Content
2Content-Type: application/vnd.api+json

Other Responses#

Code

Success

Description

404

No

Not Found

422

No

Validation Error Object. DIDs are still assigned to the group.

401

No

Unauthorized

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.

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.