Create an opt-out keyword rule
Adds one keyword-driven opt-out (STOP, UNSUBSCRIBE) or opt-in (START) rule. The inbound executor matches the keyword exactly and suppresses (or resumes) sends for the contact that sent it; an optional auto-reply is sent back. The created rule is returned. Owner/admin only. The request body — keyword (default STOP), channel (default sms, one of sms/whatsapp/rcs/viber/email), required action (opt-out or opt-in) and optional auto_reply_text — is validated by the handler’s Zod parser, which answers with a 422 envelope on a bad payload.
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