Create SMS Trunk Group#
Creates an SMS trunk group. The member trunks are tried in the order defined by their
priority.
Request#
HTTP Method: POST
URI Path: /v3/sms_trunk_groups
Request Body Object Attributes#
Name |
Type |
Nullable |
Is Required? |
Description |
|---|---|---|---|---|
name |
|
No |
Yes |
Friendly name of the SMS trunk group. Must be unique among the SMS trunks and SMS trunk groups of the account. |
external_reference_id |
|
Yes |
No |
Optional identifier for the SMS trunk group in the customer’s external system. Maximum length is 100 characters. |
Request Body Object Relationships#
Name |
Type |
Description |
|---|---|---|
sms_trunks |
The SMS trunks that form the group. Only |
Examples#
http
1POST /v3/sms_trunk_groups 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": "sms_trunk_groups",
10 "attributes": {
11 "name": "Inbound SMS"
12 },
13 "relationships": {
14 "sms_trunks": {
15 "data": [
16 {
17 "type": "sms_trunks",
18 "id": "3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24"
19 },
20 {
21 "type": "sms_trunks",
22 "id": "0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90"
23 }
24 ]
25 }
26 }
27 }
28}
curl
1curl -i -X POST https://api.didww.com/v3/sms_trunk_groups -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"name": "Inbound SMS"}, "relationships": {"sms_trunks": {"data": [{"type": "sms_trunks", "id": "3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24"}, {"type": "sms_trunks", "id": "0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90"}]}}, "type": "sms_trunk_groups"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46",
7 "type": "sms_trunk_groups",
8 "attributes": {
9 "name": "Inbound SMS",
10 "external_reference_id": null,
11 "created_at": "2026-10-22T09:15:42.118Z",
12 "updated_at": "2026-10-22T09:15:42.118Z"
13 },
14 "relationships": {
15 "sms_trunks": {
16 "links": {
17 "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/sms_trunks",
18 "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/sms_trunks"
19 }
20 },
21 "incoming_dids": {
22 "links": {
23 "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/incoming_dids",
24 "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/incoming_dids"
25 }
26 }
27 },
28 "meta": {
29 "sms_trunks_count": 2
30 }
31 },
32 "meta": {
33 "api_version": "2026-11-19"
34 }
35}
http
1POST /v3/sms_trunk_groups 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": "sms_trunk_groups",
10 "attributes": {
11 "name": "Support SMS",
12 "external_reference_id": "crm-7781"
13 }
14 }
15}
curl
1curl -i -X POST https://api.didww.com/v3/sms_trunk_groups -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"external_reference_id": "crm-7781", "name": "Support SMS"}, "type": "sms_trunk_groups"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91",
7 "type": "sms_trunk_groups",
8 "attributes": {
9 "name": "Support SMS",
10 "external_reference_id": "crm-7781",
11 "created_at": "2026-10-22T09:15:42.118Z",
12 "updated_at": "2026-10-22T09:15:42.118Z"
13 },
14 "relationships": {
15 "sms_trunks": {
16 "links": {
17 "self": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/relationships/sms_trunks",
18 "related": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/sms_trunks"
19 }
20 },
21 "incoming_dids": {
22 "links": {
23 "self": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/relationships/incoming_dids",
24 "related": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/incoming_dids"
25 }
26 }
27 },
28 "meta": {
29 "sms_trunks_count": 0
30 }
31 },
32 "meta": {
33 "api_version": "2026-11-19"
34 }
35}
Other Responses#
Code |
Success |
Description |
|---|---|---|
422 |
No |
|
400 |
No |
Bad Request. Also returned with the title |
401 |
No |
|
403 |
No |
The access token carries the |
429 |
No |
The request budget of the account for the current window is spent ( |