How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Syllable Custom Messages API

Operations related to custom message configuration. 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. For more information, see [Console docs](https://docs.syllable.ai/Resources/Messages).

Syllable Custom Messages API is one of 41 APIs that Syllable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 0.0.3.

Requests are made against a single base URL, https://api.syllable.cloud.

5 operations 2 paths 11 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.3
Base URL
https://api.syllable.cloud
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Syllable Custom Messages API declares 1 security scheme for authenticating requests. An API key is passed in the header as Syllable-API-Key (APIKeyHeader).

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

custom_messages 5

Operations related to custom message configuration. A custom message is a pre-configured message delivered by an agent as a greeting at the beginning of a conversation. Multiple a…

GET
/api/v1/custom_messages/
Custom Messages List
custom_messages_list 9 params → 200422
POST
/api/v1/custom_messages/
Create Custom Message
custom_messages_create body → 200422
PUT
/api/v1/custom_messages/
Update Custom Message
custom_messages_update body → 200422
GET
/api/v1/custom_messages/{custom_message_id}
Get Custom Message By Id
custom_message_get_by_id 1 param → 200422
DELETE
/api/v1/custom_messages/{custom_message_id}
Delete Custom Message
custom_messages_delete 2 params → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CustomMessageResponse (12 properties), CustomMessageUpdateRequest (9 properties), CustomMessageCreateRequest (8 properties), CustomMessageRule (7 properties). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
CustomMessageCreateRequest
object
Request model to create a custom message.
8 properties 2 required
OrderByDirection
string
The direction in which to order list results, either ascending or descending.
CustomMessageResponse
object
Response model for custom message operations. A custom message is a pre-configured message delivered by an agent (e.g. as a greeting at the beginning of a conv…
12 properties 6 required
CustomMessageProperties
string
CustomMessageRule
object
A rule used to determine whether a custom message should present a variant message based on the current timestamp.
7 properties 3 required
DayOfWeek
string
Available options for day of the week for use in message rules.
ValidationError
object
3 properties 3 required
CustomMessageUpdateRequest
object
Request model to update an existing custom message.
9 properties 3 required
ListResponse_CustomMessageResponse_
object
5 properties 3 required
CustomMessageType
string
Type of custom message. Greeting is for voice; emailtemplate is for email (subject + body).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

syllable-custom-messages-api-openapi.yml Raw ↑

Other APIs Syllable publishes across the network.

Syllable Agents API
Syllable Agents.test API
Syllable Bridge Phrases API
Syllable Channels API
Syllable Channels.targets API
Syllable Channels.twilio API
Syllable Channels.twilio.numbers API
Syllable Conversation Config API
Syllable Conversations API
Syllable Dashboards API
Syllable Data Sources API
Syllable Directory API
Where this information came from

This is an independent, third-party profile of Syllable Custom Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.