Skip to Content
My App
Api

Auto Reply

Manage keyword auto-replies — the automatic responses that fire when an inbound message matches a rule.

GET
/auto-replies

Authorization

http
headerAuthorizationBearer <token>

Response Body

application/json
  1. response
data*array<array<unknown>>
meta*
Example Request
curl -X GET 'https://aexrux.com/api/v1/auto-replies'
Example Response
{  "data": [    [      null    ]  ],  "meta": {    "count": 0  }}
POST
/auto-replies

Authorization

http
headerAuthorizationBearer <token>

Request Body

application/json
  1. body

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

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

Lengthlength <= 255
matching_method?|

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

Value in"fuzzy""exact""contains"
fuzzy_similarity?|

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

Range0 <= value <= 100
device_id*string

Sending device id. Required.

status?|

Whether the rule is active. Defaults to true.

reply_type?|

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

Value in"custom""flow"
flow_id?|

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?array<>|

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

Response Body

application/json
  1. response
data*array<unknown>
meta*string
Example Request
curl -X POST 'https://aexrux.com/api/v1/auto-replies' \  -H 'Content-Type: application/json' \  -d '{  "keyword": "string",  "device_id": "string"}'
Example Response
{  "data": [    null  ],  "meta": "string"}
GET
/auto-replies/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Response Body

application/json
  1. response
data*array<unknown>
meta*string
Example Request
curl -X GET 'https://aexrux.com/api/v1/auto-replies/0'
Example Response
{  "data": [    null  ],  "meta": "string"}
DELETE
/auto-replies/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Response Body

application/json
  1. response
data*
meta*string
Example Request
curl -X DELETE 'https://aexrux.com/api/v1/auto-replies/0'
Example Response
{  "data": {    "id": 0,    "deleted": true  },  "meta": "string"}
PUT
/auto-replies/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Request Body

application/json
  1. body

Update a keyword auto-reply. Scramble reads these rules to document the request body. Same shape as StoreAutoReplyRequest — the underlying AutoreplyController::update replaces the rule's settings and appends any new replies[] text variants.

keyword*string

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

Lengthlength <= 255
matching_method?|

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

Value in"fuzzy""exact""contains"
fuzzy_similarity?|

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

Range0 <= value <= 100
device_id*string

Sending device id. Required.

status?|

Whether the rule is active. Defaults to true.

reply_type?|

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

Value in"custom""flow"
flow_id?|

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?array<>|

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

Response Body

application/json
  1. response
data*array<unknown>
meta*string
Example Request
curl -X PUT 'https://aexrux.com/api/v1/auto-replies/0' \  -H 'Content-Type: application/json' \  -d '{  "keyword": "string",  "device_id": "string"}'
Example Response
{  "data": [    null  ],  "meta": "string"}