Automated Replies

Create Automated Reply

Create a new automated reply in the organization.

Required Fields:

name: Descriptive name for the automated reply
trigger: Phrase that triggers this reply
match_criteria: How the trigger should match (“exact match”, “contains”, “starts with”, “ends with”)
response_type: Type of response (“text”, “image”, “document”, “media”)
response: The actual response content

Match Criteria:

exact match: Trigger must match the entire message exactly
contains: Message must contain the trigger phrase anywhere
starts with: Message must start with the trigger phrase
ends with: Message must end with the trigger phrase

POST

api

canned-replies

curl --request POST \
  --url https://app.sentsays.com/api/canned-replies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "About Us",
  "trigger": "what do you do?",
  "match_criteria": "contains",
  "response_type": "text",
  "response": "We sell premium quality shoes for all occasions. Visit our store for the latest collection!"
}
'

{
  "statusCode": 200,
  "id": "fd3f92b5-340c-4259-a189-896a38b885d7",
  "message": "Request processed successfully"
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Body

application/json

name

string

required

Name/title of the automated reply

Minimum string length: 1

Example:

"About Us"

trigger

string

required

Trigger phrase that activates this reply

Minimum string length: 1

Example:

"what do you do?"

match_criteria

enum<string>

required

How the trigger should match incoming messages

Available options:

exact match,

contains,

starts with,

ends with

Example:

"contains"

response_type

enum<string>

required

Type of response content

Available options:

text,

image,

document,

media

Example:

"text"

response

string

required

The response content (text, URL, or file path)

Minimum string length: 1

Example:

"We sell premium quality shoes for all occasions. Visit our store for the latest collection!"

Response

Automated reply created successfully

statusCode

integer

Example:

200

string<uuid>

Example:

"fd3f92b5-340c-4259-a189-896a38b885d7"

message

string

Example:

"Request processed successfully"

Update Automated ReplyUpdate an existing automated reply by UUID. **Required Fields:** - name: Descriptive name for the automated reply - trigger: Phrase that triggers this reply - match_criteria: How the trigger should match - response_type: Type of response - response: The actual response content

⌘I

curl --request POST \
  --url https://app.sentsays.com/api/canned-replies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "About Us",
  "trigger": "what do you do?",
  "match_criteria": "contains",
  "response_type": "text",
  "response": "We sell premium quality shoes for all occasions. Visit our store for the latest collection!"
}
'

{
  "statusCode": 200,
  "id": "fd3f92b5-340c-4259-a189-896a38b885d7",
  "message": "Request processed successfully"
}

API Documentation

Endpoints

Create Automated Reply

Authorizations

Body

Response