Please note that this API relates to LivePersons legacy chat product which receives limited support and will be deprecated in the future.

It is recommended to build future integrations on top of LivePersons Unified Automatic Messages API instead.


Automatic messages are messages that are triggered automatically during a conversation to inform visitors of the status of the conversation. The messages appear in the selected visitor language to the consumer in the engagement window and to the Agent in their agent workspace.

The Automatic Messages API enables brands to find and modify Automatic Messages, which in turn support and enhance the conversation between Agent and visitor. The API facilitates the editing of automatic messages into Conversational Cloud e.g. in the case these messages are translated by an external vendor.

The API is based on the REST architecture style.

The automatic messages can be manually updated within Conversational Cloud. Each message can be translated to all the LE visitor languages and can have different text for different skills.


Getting Started

A few things you'll need to get started with this API:

  1. Retrieve your domain. Use the LivePerson Domain API to retrieve this information by providing the following service name:

    • Read only: accountConfigReadOnly

    • Read/Write: accountConfigReadWrite

  2. This API requires authorization using either a login or an API key methodology.

    • Log a user into Conversational Cloud using the Login Service API. Provide a username and password, and receive an authorization token (bearer). Use this token as your authorization header in all API requests.

    • Follow the instructions, to create and use an API key.

  3. Note the API terms of use.

  4. When using this API, it is recommended that you implement our Retry Policy and KeepAlive best practices.