Sign in

v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB
custom_messages

Custom Messages List

List the existing custom_messages

get/api/v1/custom_messages/

Query parameters

pageinteger nullable

The page number from which to start (0-based)

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25

The maximum number of items to return

search_fieldsCustomMessageProperties[]

String names of fields to search. Correspond by index to search field values

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'id' | 'name' | 'name_exact' | 'text' | 'label' | 'type' | 'updated_at' | 'agent_id'

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsCustomMessageProperties[] nullable

The fields to include in the response

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z

The start datetime for filtering results

end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

The end datetime for filtering results

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "name": "Customer service greeting",
      "preamble": "If this is an emergency, please hang up and call 911.",
      "text": "Hello and thank you for calling customer service. How can I help you today?",
      "subject": "Your appointment reminder",
      "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"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}