Update Sender ID Verification#

Updates a Sender ID verification.

Only name and the sms_trunk relationship can be changed. All of them are optional. A closed verification cannot be updated: the request is rejected with 422.

Request#

HTTP Method: PATCH

URI Path: /v3/sender_id_verifications/{id}

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique identifier of the Sender ID verification.

Request Body Object Attributes#

Name

Type

Nullable

Is Required?

Description

name

string

No

No

Name of the Sender ID verification.

Request Body Object Relationships#

Name

Type

Description

sms_trunk

To one

The SMS Trunk outbound messages are routed through. Only http_out, smpp_smsc, and smpp_esme trunks are accepted. Send data: null to unassign it; outbound messages then stop until a trunk is assigned again.

Examples#

http

 1PATCH /v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10 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": "e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10",
10    "type": "sender_id_verifications",
11    "attributes": {
12      "name": "ACME notifications"
13    }
14  }
15}

curl

1curl -i -X PATCH https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"name": "ACME notifications"}, "id": "e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10", "type": "sender_id_verifications"}}'

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10",
 7    "type": "sender_id_verifications",
 8    "attributes": {
 9      "name": "ACME notifications",
10      "status": "active",
11      "sender_type": "alphanumeric",
12      "sender_ids": [
13        "ACME"
14      ],
15      "reference": "SID-1234",
16      "reject_reasons": null,
17      "reject_comment": null,
18      "renew_date": "2026-11-22",
19      "created_at": "2026-10-22T09:15:42.118Z",
20      "activated_at": "2026-10-22T11:40:03.512Z",
21      "closed_at": null
22    },
23    "relationships": {
24      "sms_trunk": {
25        "links": {
26          "self": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/relationships/sms_trunk",
27          "related": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/sms_trunk"
28        }
29      },
30      "countries": {
31        "links": {
32          "self": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/relationships/countries",
33          "related": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/countries"
34        }
35      },
36      "dids": {
37        "links": {
38          "self": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/relationships/dids",
39          "related": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/dids"
40        }
41      },
42      "order": {
43        "links": {
44          "self": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/relationships/order",
45          "related": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/order"
46        }
47      },
48      "identity": {
49        "links": {
50          "self": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/relationships/identity",
51          "related": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/identity"
52        }
53      },
54      "address": {
55        "links": {
56          "self": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/relationships/address",
57          "related": "https://api.didww.com/v3/sender_id_verifications/e5a4e2f1-3b26-4a5c-9a0a-2f7c1f3e8d10/address"
58        }
59      }
60    },
61    "meta": {
62      "setup_price": "10.0",
63      "monthly_price": "15.0"
64    }
65  },
66  "meta": {
67    "api_version": "2026-11-19"
68  }
69}

Other Responses#

Code

Success

Description

404

No

Not Found

422

No

Validation Error Object. The verification is closed, another verification already uses one of its Sender IDs on the SMS trunk, or the SMS trunk is unknown or does not support outbound messages.

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.