PUT
/
api
/
v1
/
custom_messages
import os
import syllable_sdk
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.custom_messages.update(request={
        "name": "Customer service greeting",
        "text": "Hello and thank you for calling customer service. How can I help you today?",
        "label": "Customer service",
        "rules": [
            {
                "description": "Closed on New Year's Day",
                "time_range_start": "09:00",
                "time_range_end": "17:00",
                "date_": "2025-01-01",
                "days_of_week": [
                    syllable_sdk.DayOfWeek.MO,
                    syllable_sdk.DayOfWeek.TU,
                    syllable_sdk.DayOfWeek.WE,
                    syllable_sdk.DayOfWeek.TH,
                    syllable_sdk.DayOfWeek.FR,
                ],
                "invert": False,
                "text": "Hello, thank you for calling. Sorry, we're closed today.",
            },
            {
                "description": "Closed on New Year's Day",
                "time_range_start": "09:00",
                "time_range_end": "17:00",
                "date_": "2025-01-01",
                "days_of_week": [
                    syllable_sdk.DayOfWeek.MO,
                    syllable_sdk.DayOfWeek.TU,
                    syllable_sdk.DayOfWeek.WE,
                    syllable_sdk.DayOfWeek.TH,
                    syllable_sdk.DayOfWeek.FR,
                ],
                "invert": False,
                "text": "Hello, thank you for calling. Sorry, we're closed today.",
            },
        ],
        "id": 1,
    })

    # Handle response
    print(res)
{
  "name": "Customer service greeting",
  "text": "Hello and thank you for calling customer service. How can I help you today?",
  "label": "Customer service",
  "rules": [
    {
      "date": "2025-01-01",
      "description": "Closed on New Year's Day",
      "invert": false,
      "text": "Hello, thank you for calling. Sorry, we're closed today.",
      "time_range_end": "17:00",
      "time_range_start": "09:00"
    },
    {
      "days_of_week": [
        "sa",
        "su"
      ],
      "description": "Closed on weekends",
      "invert": false,
      "text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
      "time_range_end": "17:00",
      "time_range_start": "09:00"
    }
  ],
  "id": 1,
  "updated_at": "2024-01-01T00:00:00Z",
  "agent_count": 1,
  "last_updated_by": "user@email.com",
  "type": "greeting"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json

Request model to update an existing custom message.

​
name
string
required

The name of the custom message

Example:

"Customer service greeting"

​
text
string
required

The default message that the agent will deliver if no rules are set or no rules match the current timestamp.

Example:

"Hello and thank you for calling customer service. How can I help you today?"

​
id
integer
required

The ID of the custom message

Example:

1

​
label
string | null

The label of the custom message

Example:

"Customer service"

​
rules
object[]

Rules for time-specific message variants

A rule used to determine whether a custom message should present a variant message based on the current timestamp.

Example:
[
  {
    "date": "2025-01-01",
    "description": "Closed on New Year's Day",
    "invert": false,
    "text": "Hello, thank you for calling. Sorry, we're closed today.",
    "time_range_end": "17:00",
    "time_range_start": "09:00"
  },
  {
    "days_of_week": ["sa", "su"],
    "description": "Closed on weekends",
    "invert": false,
    "text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
    "time_range_end": "17:00",
    "time_range_start": "09:00"
  }
]
​
type
string
default:greeting

Type of the custom message (must be "greeting" for now)

Example:

"greeting"

Response

200
application/json
Successful Response

Response model for custom message operations. 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.

​
name
string
required

The name of the custom message

Example:

"Customer service greeting"

​
text
string
required

The default message that the agent will deliver if no rules are set or no rules match the current timestamp.

Example:

"Hello and thank you for calling customer service. How can I help you today?"

​
id
integer
required

The ID of the custom message

Example:

1

​
updated_at
string
required

Timestamp of the most recent update to the custom message

Example:

"2024-01-01T00:00:00Z"

​
last_updated_by
string
required

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

Example:

"user@email.com"

​
label
string | null

The label of the custom message

Example:

"Customer service"

​
rules
object[]

Rules for time-specific message variants

A rule used to determine whether a custom message should present a variant message based on the current timestamp.

Example:
[
  {
    "date": "2025-01-01",
    "description": "Closed on New Year's Day",
    "invert": false,
    "text": "Hello, thank you for calling. Sorry, we're closed today.",
    "time_range_end": "17:00",
    "time_range_start": "09:00"
  },
  {
    "days_of_week": ["sa", "su"],
    "description": "Closed on weekends",
    "invert": false,
    "text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
    "time_range_end": "17:00",
    "time_range_start": "09:00"
  }
]
​
agent_count
integer | null

The number of agents using the custom message

Example:

1

​
type
string
default:greeting

Type of the custom message (must be "greeting" for now)

Example:

"greeting"