Update SMS carrier

PUT

/smscarriers/{carrier}

Last modified:2026-10-07 23:41:51

OperationId:UpdateSmsCarrier

Changes an SMS carrier. Requires Super User scope.

Builtin carrier. Send enabled; every other field is ignored. enabled only hides or shows the carrier in the portal. It does not change how messages are sent. The builtin name is matched without regard to case.

Custom carrier. Send the fields to change; fields you leave out keep their values. An empty string removes a field. custom-outbound-json-fields replaces the whole map. enabled is ignored: a custom carrier is always enabled.

Fields the carrier record does not have, the read-only fields, and a masked auth copied from a read are ignored. Put the carrier credential in auth, or, for a carrier that takes it in the body, in custom-outbound-json-fields. Both read back masked. In custom-outbound-json-fields, an entry sent back exactly as a read masked it keeps its stored value; any other masked entry is refused with 400.

The change is saved to the configuration of the server that answers the request, and is in effect when the response arrives. Other servers in the cluster do not receive it.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

The change is saved.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/smscarriers/acme-sms' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "enabled": false
}'

Response Example

202 - Hide a builtin carrier

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-07 23:41:51

Read SMS carrier

Delete custom SMS carrier