Skip to main content
PATCH
Update SMPP carrier

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Body

application/json
label
any

New human-readable name, 1–64 characters.

remoteHost
any

New SMPP upstream host (hostname / IPv4 / IPv6 literal).

remotePort
any

New SMPP upstream port, 1–65535.

remoteSystemId
any

New SMPP system_id, 1–15 characters.

remotePassword
any

New SMPP bind password, 1–8 characters; encrypted at rest.

scope
any

New routing scope: all or by_country_mcc.

scopeFilter
any

New { mccs: string[] } filter (1–50 three-digit MCCs), or null to clear.

priority
any

New route priority, 0–10000 (lower wins).

status
any

New lifecycle status — active, suspended or inactive.

Response

The updated carrier and its full configuration, wrapped in the standard { data, meta } envelope. Credential material is never present — only the *Set booleans.

The updated carrier and its full configuration, wrapped in the standard { data, meta } envelope. Credential material is never present — only the *Set booleans.