SMS

Update an SMS number

Changed on

Updates an SMS number's user-facing label, its brand prefix override, and/or link shortening. Omitted fields keep their value; at least one field is required. Link shortening changes apply to messages prepared after the change. Requires companies:manage.

patch/sms/numbers/{numberId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sms/numbers/{numberId}
  • Auth
    HTTP bearer

Path parameters

numberIdstring required

SMS number ID returned by Get SMS Settings.

Request body

labelstring nullable

Label such as Marketing or Support. Send null to clear it.

brandPrefixstring nullable

Per-number brand prefix override; messages send as "{prefix}: your message". Send null to clear it back to the account-wide prefix.

linkShorteningEnabledboolean

true replaces links in messages from this number with click-tracked short links; false sends them exactly as written, so SMS clicks from this number are not tracked.

Response

SMS number updated

successboolean
messagestring

Example response

{
  "success": true,
  "number": {
    "id": "num_abc123",
    "label": "Marketing",
    "brandPrefix": "Acme Support"
  },
  "message": "SMS number updated."
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

  • f1d8cfd9faafRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable