Skip to main content
PATCH
Update SMPP credential

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
description
any

New human-readable label (1–200 chars), or null to clear.

tpsLimit
any

New inbound throughput cap, 1–1000 messages/second.

allowedCidrs
any

Replacement CIDR allow-list (up to 16 IPv4/IPv6 CIDR strings).

dlrMode
any

New delivery-receipt mode: bind, webhook or both.

dlrWebhookUrl
any

HTTPS webhook endpoint for DLRs, or null to clear; required when dlrMode is webhook or both.

status
any

New lifecycle status — active, suspended or revoked; reconciler-routed to Jasmin.

Response

The updated SMPP credential and its full configuration, wrapped in the standard { data, meta } envelope. Password material is never present.

The updated SMPP credential and its full configuration, wrapped in the standard { data, meta } envelope. Password material is never present.