Skip to main content
POST
Create a keyword rule

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

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.

Required string length: 1 - 255
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

Body

application/json

Keyword rule fields in snake_case. Legacy action aliases (forward/agent/flow) are accepted and normalised to the run-time canon.

Keyword rule fields in snake_case. Legacy action aliases (forward/agent/flow) are accepted and normalised to the run-time canon.

keyword
string

The inbound word to match (required on create).

Minimum string length: 1
channel
enum<string>
default:sms

Channel the rule applies to.

Available options:
sms,
whatsapp,
rcs,
viber,
email
match_type
enum<string>
default:exact

How the keyword is matched against the inbound text.

Available options:
exact,
contains,
starts_with,
regex
action
enum<string>
default:reply

Action to take on match. Legacy aliases forward/agent (→ forward_agent) and flow (→ trigger_flow) are normalised.

Available options:
reply,
forward,
agent,
forward_agent,
flow,
trigger_flow,
opt-out,
opt-in
response_text
string

Auto-reply body for reply/opt-out/opt-in actions.

agent_id
string

Agent to route matched messages to (forward_agent).

flow_id
string

Flow to launch on a match (trigger_flow).

active
boolean
default:true

Whether the rule is active immediately.

Response

The created keyword rule.

The created keyword rule.

data
object

A keyword rule in its camelCase stored form.

meta
object