Update Inbound Trunk Group#

Updates a Trunk Group.

Request#

HTTP Method: PATCH

URI Path: /v3/voice_in_trunk_groups/{id}

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of Trunk Group.

Request Body Object Attributes#

Name

Type

Nullable

Is Required?

Description

name

string

No

No

Name of the Trunk Group. Unique among the trunks and trunk groups of the account — they share one name space.

external_reference_id

string

Yes

No

Optional identifier for the trunk group in the customer’s external system. Maximum length is 100 characters.

capacity_limit

integer

Yes

No

Maximum number of simultaneous calls for the Trunk Group.

Request Body Object Relationships#

Name

Type

Description

voice_in_trunks

To many

Replaces the whole membership of the group with the trunks listed here. At most 10 distinct trunks; a trunk listed twice is counted once.

Examples#

http

 1PATCH /v3/voice_in_trunk_groups/43deb3aa-674a-465e-ac16-fb3084325ec7 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": "43deb3aa-674a-465e-ac16-fb3084325ec7",
10    "type": "voice_in_trunk_groups",
11    "attributes": {
12      "name": "Renamed group",
13      "capacity_limit": 1
14    }
15  }
16}

curl

1curl -i -X PATCH https://api.didww.com/v3/voice_in_trunk_groups/43deb3aa-674a-465e-ac16-fb3084325ec7 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"capacity_limit": 1, "name": "Renamed group"}, "id": "43deb3aa-674a-465e-ac16-fb3084325ec7", "type": "voice_in_trunk_groups"}}'

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "43deb3aa-674a-465e-ac16-fb3084325ec7",
 7    "type": "voice_in_trunk_groups",
 8    "attributes": {
 9      "created_at": "2017-06-25T14:56:31.513Z",
10      "external_reference_id": null,
11      "name": "Renamed group",
12      "capacity_limit": 1
13    },
14    "relationships": {
15      "voice_in_trunks": {
16        "links": {
17          "self": "https://api.didww.com/v3/voice_in_trunk_groups/43deb3aa-674a-465e-ac16-fb3084325ec7/relationships/voice_in_trunks",
18          "related": "https://api.didww.com/v3/voice_in_trunk_groups/43deb3aa-674a-465e-ac16-fb3084325ec7/voice_in_trunks"
19        }
20      }
21    },
22    "meta": {
23      "trunks_count": 1
24    }
25  },
26  "meta": {
27    "api_version": "2026-11-19"
28  }
29}

Other Responses#

Code

Success

Description

404

No

Not Found

422

No

Unprocessable Entity

400

No

Bad Request. The body carries a member the API does not accept.

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.