Reject a short-code application
Record an aggregator / carrier rejection of an SMS short-code application: move it to rejected and store the rejection reason surfaced to the operator. Use this to relay a hard rejection from the carrier review so the timeline and the dashboard reflect that the application will not proceed. Returns 404 if no application with that id belongs to the caller’s organization. Requires the numbers:write scope (owner / admin).
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox 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.
true, false Path Parameters
Resource identifier
1Body
The aggregator / carrier rejection reason to record.
The aggregator / carrier rejection reason to record.
The aggregator / carrier rejection reason.