Regenerate SMS Trunk Credentials#

Replaces the credentials DIDWW generated for an SMS trunk:

  • smpp_esme trunks receive a new system_id and password.

  • http_out trunks receive a new auth_name and auth_password.

The new credentials replace the previous ones. Update your application to use them.

Note

  • The endpoint applies only to smpp_esme and http_out trunks. Any other trunk type, or a trunk that does not belong to the account, is rejected with 422.

  • The response contains only the trunk ID. To read the new credentials, retrieve the trunk with Get SMS Trunk.

Request#

HTTP Method: POST

URI Path: /v3/sms_trunk_regenerate_credentials

Request Body Relationships#

Name

Type

Is Required?

Description

sms_trunk

SMS Trunk Object

Yes

The smpp_esme or http_out trunk whose credentials should be regenerated.

Example#

http

 1POST /v3/sms_trunk_regenerate_credentials 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_regenerate_credentials",
10    "relationships": {
11      "sms_trunk": {
12        "data": {
13          "type": "sms_trunks",
14          "id": "8e4b2c6a-9d1f-4a3e-b7c5-5f0d2e8a1b67"
15        }
16      }
17    }
18  }
19}

curl

1curl -i -X POST https://api.didww.com/v3/sms_trunk_regenerate_credentials -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"relationships": {"sms_trunk": {"data": {"id": "8e4b2c6a-9d1f-4a3e-b7c5-5f0d2e8a1b67", "type": "sms_trunks"}}}, "type": "sms_trunk_regenerate_credentials"}}'

response

 1HTTP/1.1 201 Created
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "8e4b2c6a-9d1f-4a3e-b7c5-5f0d2e8a1b67",
 7    "type": "sms_trunk_regenerate_credentials"
 8  },
 9  "meta": {
10    "api_version": "2026-11-19"
11  }
12}

Other Responses#

Code

Success

Description

422

No

Validation Error Object. The trunk has no credentials to regenerate or does not belong to the account.

400

No

Bad Request

401

No

Unauthorized

403

No

The access token carries the read scope, which does not cover this method (title Insufficient scope). The response carries 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.