Skip to main content
POST
Create auto-replies

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a keyword auto-reply. Scramble reads these rules to document the request body. Mirrors the input keys the existing AutoreplyController::store accepts, exposed under public-facing names. A "custom" reply carries one or more replies[] text variants; a "flow" reply points at a saved flow_id.

keyword
string
required

Trigger keyword(s). Comma-separated phrases are allowed. Required.

Maximum string length: 255
device_id
string
required

Sending device id. Required.

matching_method
enum<string> | null

How the inbound message is matched against the keyword. Defaults to exact.

Available options:
fuzzy,
exact,
contains
fuzzy_similarity
integer | null

Fuzzy match threshold 0-100 (only used when matching_method=fuzzy).

Required range: 0 <= x <= 100
status
boolean | null

Whether the rule is active. Defaults to true.

reply_type
enum<string> | null

Reply kind: "custom" (text variants) or "flow" (a saved flow). Defaults to custom.

Available options:
custom,
flow
flow_id
integer | null

Flow id to run (required when reply_type=flow). Scope to the caller's workspace so an auto-reply can't reference another tenant's flow (was a bare integer with no ownership).

replies
string[] | null

Reply text variants (for reply_type=custom). At least one required for custom.

Maximum string length: 4096

Response

Resource created successfully.

data
any[]
required
meta
string
required