POST
/
api
/
v1
/
custom_messages

Authorizations

Syllable-API-Key
string
header
required

Body

application/json
name
string
required

The name of the custom message

text
string
required

The text of the custom message

label
string | null

The label of the custom message

rules
object[]

Rules for time-specific message variants

type
string
default:
greeting

Response

200
application/json

A custom message is a pre-configured message delivered by an agent as a greeting at the beginning of a conversation. Multiple agents can use the same custom mesasage. A custom message has one or more rules defined, which allow for different messages to be dynamically selected and delivered at runtime based on the current time and either date or day of the week.

name
string
required

The name of the custom message

text
string
required

The text of the custom message

id
integer
required

The ID of the custom message

updated_at
string
required

Timestamp of the most recent update to the custom message

last_updated_by
string
required

The email address of the user who most recently updated the custom message

label
string | null

The label of the custom message

rules
object[]

Rules for time-specific message variants

agent_count
integer | null

The number of agents using the custom message

type
string
default:
greeting