Update DID#
Update the settings of a single DID owned by your account. Using this endpoint you can cancel, restore or renew DID.
To cancel a DID, attribute terminated must be true, to renew or restore DID attribute terminated must be false.
Request#
HTTP Method: PATCH
URI Path: /v3/dids/{id}
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID number allocated to this DID |
Attributes#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
terminated |
|
Optional |
If set to |
description |
|
Optional |
A DID number description. |
billing_cycles_count |
|
Optional |
The number of Billing Cycles that this DID Number will renew until expiration. If set to |
dedicated_channels_count |
|
Optional |
Amount of dedicated channels to assign. |
capacity_limit |
|
Optional |
Limits incoming capacity per DID number according to entered value. If set as |
Inbound SMS Routing#
A DID routes inbound SMS to one SMS trunk or to one SMS trunk group, never both. Set the
route with the sms_trunk relationship (see SMS Trunks) or
the sms_trunk_group relationship (see SMS Trunk Groups).
Assigning one of the two relationships replaces the route set through the other one.
Sending both
sms_trunkandsms_trunk_groupwith an ID in the same request returns422 Unprocessable Entity. Sending one of them with an ID and the other with"data": nullassigns the ID.The SMS trunk must accept inbound SMS. A trunk with the
http_outconfiguration type is rejected with422 Unprocessable Entity.The DID Group of the DID must support inbound SMS (its
featuresincludesms_in). Otherwise the request returns422 Unprocessable Entity.An SMS trunk or SMS trunk group that does not exist or does not belong to your account returns
422 Unprocessable Entity.Sending
"data": nullclears the route only when the DID is currently routed through that relationship. For example,sms_trunk_groupwith"data": nulldoes not change a DID routed to a single SMS trunk.
Examples#
http
1PATCH /v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70 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": "46e129f1-deaa-44db-8915-2646de4d4c70",
10 "type": "dids",
11 "attributes": {
12 "terminated": false,
13 "description": "string",
14 "capacity_limit": 1
15 }
16 }
17}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70 -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, "description": "string", "terminated": false}, "id": "46e129f1-deaa-44db-8915-2646de4d4c70", "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/order",
32 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/46e129f1-deaa-44db-8915-2646de4d4c70/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5 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": "3505b18a-3019-47bc-95d1-0f9ec7766fd5",
10 "type": "dids",
11 "relationships": {
12 "voice_in_trunk": {
13 "data": {
14 "type": "voice_in_trunks",
15 "id": "c80d096a-c8cf-4449-aa6d-8bac39130fe0"
16 }
17 }
18 }
19 }
20}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "3505b18a-3019-47bc-95d1-0f9ec7766fd5", "relationships": {"voice_in_trunk": {"data": {"id": "c80d096a-c8cf-4449-aa6d-8bac39130fe0", "type": "voice_in_trunks"}}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "3505b18a-3019-47bc-95d1-0f9ec7766fd5",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/order",
32 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/3505b18a-3019-47bc-95d1-0f9ec7766fd5/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/3e3f57ec-0541-473a-af63-103216d19db3 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": "3e3f57ec-0541-473a-af63-103216d19db3",
10 "type": "dids",
11 "relationships": {
12 "voice_in_trunk_group": {
13 "data": {
14 "type": "voice_in_trunk_groups",
15 "id": "1dc6e448-d9d8-4da8-a34b-21459b03112f"
16 }
17 }
18 }
19 }
20}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "3e3f57ec-0541-473a-af63-103216d19db3", "relationships": {"voice_in_trunk_group": {"data": {"id": "1dc6e448-d9d8-4da8-a34b-21459b03112f", "type": "voice_in_trunk_groups"}}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "3e3f57ec-0541-473a-af63-103216d19db3",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/order",
32 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/3e3f57ec-0541-473a-af63-103216d19db3/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9 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": "a8d13b71-8f0b-4393-8992-ff5e4e7521f9",
10 "type": "dids",
11 "attributes": {
12 "dedicated_channels_count": 2
13 },
14 "relationships": {
15 "capacity_pool": {
16 "data": {
17 "type": "capacity_pools",
18 "id": "1eb75a47-38b6-4ec2-8990-fe249ffd7b92"
19 }
20 }
21 }
22 }
23}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"dedicated_channels_count": 2}, "id": "a8d13b71-8f0b-4393-8992-ff5e4e7521f9", "relationships": {"capacity_pool": {"data": {"id": "1eb75a47-38b6-4ec2-8990-fe249ffd7b92", "type": "capacity_pools"}}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "a8d13b71-8f0b-4393-8992-ff5e4e7521f9",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": null,
12 "terminated": false,
13 "awaiting_registration": false,
14 "created_at": "2019-05-21T08:25:02.223Z",
15 "number": "4474183XXXXX",
16 "expires_at": "2019-06-21T08:25:13.367Z",
17 "channels_included_count": 2,
18 "dedicated_channels_count": 2,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/order",
32 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9 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": "a8d13b71-8f0b-4393-8992-ff5e4e7521f9",
10 "type": "dids",
11 "relationships": {
12 "shared_capacity_group": {
13 "data": {
14 "type": "shared_capacity_groups",
15 "id": "8a581244-de83-4c46-ac0a-32659279169e"
16 }
17 }
18 }
19 }
20}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "a8d13b71-8f0b-4393-8992-ff5e4e7521f9", "relationships": {"shared_capacity_group": {"data": {"id": "8a581244-de83-4c46-ac0a-32659279169e", "type": "shared_capacity_groups"}}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "a8d13b71-8f0b-4393-8992-ff5e4e7521f9",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": null,
12 "terminated": false,
13 "awaiting_registration": false,
14 "created_at": "2019-05-21T08:25:02.223Z",
15 "number": "4474183XXXXX",
16 "expires_at": "2019-06-21T08:25:13.367Z",
17 "channels_included_count": 2,
18 "dedicated_channels_count": 2,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/order",
32 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/a8d13b71-8f0b-4393-8992-ff5e4e7521f9/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5 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": "dids",
10 "id": "1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5",
11 "relationships": {
12 "voice_in_trunk": {
13 "data": null
14 }
15 }
16 }
17}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5", "relationships": {"voice_in_trunk": {"data": null}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": null,
12 "terminated": false,
13 "awaiting_registration": false,
14 "created_at": "2019-05-21T08:25:02.223Z",
15 "number": "4474183XXXXX",
16 "expires_at": "2019-06-21T08:25:13.367Z",
17 "channels_included_count": 2,
18 "dedicated_channels_count": 2,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/order",
32 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03 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": "8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03",
10 "type": "dids",
11 "relationships": {
12 "sms_trunk": {
13 "data": {
14 "type": "sms_trunks",
15 "id": "b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34"
16 }
17 }
18 }
19 }
20}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03", "relationships": {"sms_trunk": {"data": {"id": "b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34", "type": "sms_trunks"}}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": "Support line",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "4420xxxxxxxx",
15 "expires_at": "2026-11-20T09:15:00.000Z",
16 "channels_included_count": 2,
17 "created_at": "2026-10-20T09:15:00.000Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/order",
32 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f 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": "c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f",
10 "type": "dids",
11 "relationships": {
12 "sms_trunk_group": {
13 "data": {
14 "type": "sms_trunk_groups",
15 "id": "e4f5a6b7-8c9d-4e0f-a1b2-c3d4e5f6a7b8"
16 }
17 }
18 }
19 }
20}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f", "relationships": {"sms_trunk_group": {"data": {"id": "e4f5a6b7-8c9d-4e0f-a1b2-c3d4e5f6a7b8", "type": "sms_trunk_groups"}}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": "Support line",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "4420xxxxxxxx",
15 "expires_at": "2026-11-20T09:15:00.000Z",
16 "channels_included_count": 2,
17 "created_at": "2026-10-20T09:15:00.000Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/order",
32 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/c7d2e9f1-4a3b-4c6d-8e5f-0a1b2c3d4e5f/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03 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": "8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03",
10 "type": "dids",
11 "relationships": {
12 "sms_trunk": {
13 "data": null
14 }
15 }
16 }
17}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03", "relationships": {"sms_trunk": {"data": null}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": "Support line",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "4420xxxxxxxx",
15 "expires_at": "2026-11-20T09:15:00.000Z",
16 "channels_included_count": 2,
17 "created_at": "2026-10-20T09:15:00.000Z",
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/order",
32 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/8a6f3c2e-1b4d-4f7a-9e2c-5d8b7a6f1c03/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5 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": "dids",
10 "id": "1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5",
11 "relationships": {
12 "address_verification": {
13 "data": null
14 }
15 }
16 }
17}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5", "relationships": {"address_verification": {"data": null}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": null,
12 "terminated": false,
13 "awaiting_registration": false,
14 "created_at": "2019-05-21T08:25:02.223Z",
15 "number": "4474183XXXXX",
16 "expires_at": "2019-06-21T08:25:13.367Z",
17 "channels_included_count": 2,
18 "dedicated_channels_count": 2,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/order",
32 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/1e0c45b1-1fea-4552-b41b-ffa9f5eb44c5/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
http
1PATCH /v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa 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": "dids",
10 "id": "cc4c423f-68b5-4e1a-878c-2328eb24f3fa",
11 "relationships": {
12 "emergency_calling_service": {
13 "data": null
14 }
15 }
16 }
17}
curl
1curl -i -X PATCH https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "cc4c423f-68b5-4e1a-878c-2328eb24f3fa", "relationships": {"emergency_calling_service": {"data": null}}, "type": "dids"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "cc4c423f-68b5-4e1a-878c-2328eb24f3fa",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": null,
11 "description": null,
12 "terminated": false,
13 "awaiting_registration": false,
14 "created_at": "2026-01-10T08:00:00.000Z",
15 "number": "12125550100",
16 "expires_at": "2026-07-15T00:00:00.000Z",
17 "channels_included_count": 2,
18 "dedicated_channels_count": 0,
19 "billing_cycles_count": null,
20 "emergency_enabled": false
21 },
22 "relationships": {
23 "did_group": {
24 "links": {
25 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/did_group",
26 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/did_group"
27 }
28 },
29 "order": {
30 "links": {
31 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/order",
32 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/order"
33 }
34 },
35 "voice_in_trunk": {
36 "links": {
37 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/voice_in_trunk",
38 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/voice_in_trunk"
39 }
40 },
41 "voice_in_trunk_group": {
42 "links": {
43 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/voice_in_trunk_group",
44 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/voice_in_trunk_group"
45 }
46 },
47 "capacity_pool": {
48 "links": {
49 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/capacity_pool",
50 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/capacity_pool"
51 }
52 },
53 "shared_capacity_group": {
54 "links": {
55 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/shared_capacity_group",
56 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/shared_capacity_group"
57 }
58 },
59 "sms_trunk": {
60 "links": {
61 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/sms_trunk",
62 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/sms_trunk"
63 }
64 },
65 "sms_trunk_group": {
66 "links": {
67 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/sms_trunk_group",
68 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/sms_trunk_group"
69 }
70 },
71 "address_verification": {
72 "links": {
73 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/address_verification",
74 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/address_verification"
75 }
76 },
77 "emergency_calling_service": {
78 "links": {
79 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/emergency_calling_service",
80 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/emergency_calling_service"
81 }
82 },
83 "emergency_verification": {
84 "links": {
85 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/emergency_verification",
86 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/emergency_verification"
87 }
88 },
89 "identity": {
90 "links": {
91 "self": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/relationships/identity",
92 "related": "https://api.didww.com/v3/dids/cc4c423f-68b5-4e1a-878c-2328eb24f3fa/identity"
93 }
94 }
95 }
96 },
97 "meta": {
98 "api_version": "2026-11-19"
99 }
100}
Note
Unassigning a DID from its Emergency Calling Service does not cancel the service. A service left with no remaining DIDs is automatically canceled within a few hours, and DIDWW notifies the customer.
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
400 |
No |
|
401 |
No |
|
403 |
No |
The access token carries the |
422 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |