Create custom SMS carrier

POST

/smscarriers

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

OperationId:CreateSmsCarrier

Adds a custom SMS carrier: the outbound request the platform sends to the carrier, and how to read the carrier's inbound webhook. Requires Super User scope.

Send carrier and url. The name must not be a builtin carrier (bandwidth, onvoy, inteliquent, messagemedia, impact, brightlink, thinq, voipinno, and teli), twillio, nullResponseFields, or an existing custom carrier. Fields the carrier record does not have, and the read-only type, enabled, mms-capable, and group-mms-capable, are ignored, as is a masked auth copied from a read. So a row from GET /smscarriers can be sent back as it is.

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. A masked value in custom-outbound-json-fields is refused with 400: send the real value.

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 ********************

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

The change is saved.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

JSON carrier with a bearer tokenMinimal

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/smscarriers' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "carrier": "acme-sms",
    "url": "https://sms.example.com/v1/messages",
    "auth": "{{carrier_api_key}}",
    "auth-type": "Bearer Token",
    "inbound-to": "to",
    "inbound-from": "from",
    "inbound-text": "text",
    "outbound-to": "to",
    "outbound-from": "from",
    "outbound-text": "text",
    "json-encode": true,
    "content-type": "application/json",
    "outbound-include-auth-header": true,
    "set-http-header": true
}'

Response Example

202 - JSON carrier with a bearer token

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

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

List SMS carriers

Read SMS carrier