fc5624c7d57a

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-13260150938.9 KB

SMS

Update an SMS number

Updates an SMS number's user-facing label and/or its brand prefix override. Omitted fields keep their value; at least one field is required. Requires companies:manage.

patch/sms/numbers/{numberId}

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.

Response

SMS number updated

successboolean

messagestring

Example response

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