Changelog

​

Properties

• Added ai_greeting as a possible value of the chats.welcome_message_source event property.

​

Canned responses

• Added the following methods:
  • Create canned response
  • Update canned response
  • List canned responses
  • Delete canned response

​

Canned responses

• Changed Create canned response to use the canned_responses--groups:rw and canned_responses--all:rw scopes.

​

Events

• Added the ticket_created system event.

​

Properties

• Added the ai_agents.sources_used event property.

​

Customers

• Customer responses no longer include monitoring.version.
• The List customers and Get customers count methods support filtering by last_chat_at, last_ticket_created_at, and last_ticket_customer_message_at.

​

Segments

• The Create segment definition method can create the qualified lead definition or restore a deleted lead or qualified lead definition.

​

Customers

• Added relationship_level to the Customer data structure and relationship-level changes to the customer_updated push.

​

Customer properties

• Added the text customer property type.

​

Customers

• Added opt_ins and monitoring.suggested_email to customer responses.
• Added suggested_email filters and free-text search to List customers and Get customers count.

​

Segments

• Added support for deleting and restoring built-in definitions to Delete segment definition and Create segment definition.

​

Other

• Added ai_agent_response_scope to Request Welcome Message (Web and RTM).

​

Ecommerce

• Added the Set customer cart method.

​

Catalog

• Added the Product Directory API.
• Added the following methods:
  • Upload a product catalog
  • Check import status
  • List catalogs
  • Get catalog details

​

Customers

• Added segment_memberships to the Customer data structure.
• Added the segment_memberships_updated push.
• Added carts to the Customer data structure.
• Added cart data to the customer_updated push.
• Changed Update Customer (Web and RTM) to accept empty strings for clearing name, email, phone_number, and address components.

​

Configuration

• Added the following pushes:
  • canned_response_created
  • canned_response_updated
  • canned_response_deleted

​

Chats

• Added the chat_ids and agent_types filters to List Archives.
• Renamed Chat summary to Chat info and last_thread_summary to last_thread_info.
• Changed the List Chats and Login RTM responses by renaming chats_summary to chats_info, moving last_event_per_type inside last_thread_info, removing its event wrapper, and moving restricted_access to last_thread_info.

​

Other

• Removed the customers.ids recipient type from Multicast across all API versions.

​

Customers

• Changed Update Customer (Web and RTM) to accept empty strings for clearing name, email, and address components.

​

Chats

• Changed the List Chats response (Web and RTM) by renaming chats_summary to chats_info, moving last_event_per_type inside last_thread_info, and removing its event wrapper.

​

Customers

• Added an optional groups response field to the Update Customer Page RTM method.

​

Other

• Replaced Get Predicted Agent with Request Welcome Message.
• Added the incoming_welcome_message push.

​

Allowed domains

• Added the following methods for managing allowed domains:
  • Add Allowed Domain
  • List Allowed Domains
  • Delete Allowed Domain

​

Canned responses

• Added the following methods for managing canned responses:
  • Create Canned Response
  • Update Canned Response
  • List Canned Responses
  • Delete Canned Response

​

Customer bans

• Added the Ban Customer method.

​

Forms

• Added the phone and date field types to prechat forms.
• Added the following methods for managing forms:
  • Get form
  • Update form
  • Delete form

​

Greetings

• Added the url_match_page_view_number greeting rule type to Create Greeting.

​

Translations

• Added the following methods for managing translations:
  • Update Translations
  • List Translations

​

Customer properties

• Added the following methods for managing customer property definitions:
  • Create customer property definition
  • Update customer property definition
  • Delete customer property definition
  • List customer property definitions
• Added the Set customer properties values method.
• Added has_value and type_configuration.allowed_values to customer property definitions.
• Added customer_properties to the Get customer and Get merged customer responses.
• Added custom customer property filtering through customer_property to List customers and Get customers count.
• Made the timestamp property format immutable after creation.
• Added support for updating type_configuration.allowed_values to Update customer property definition.

​

Customers

• Added the Has sales events method.
• Added segment_memberships to the Get customer and Get merged customer responses.
• Added the Update customer method.
• Added relationship_level and Instagram, Telegram, and SMS omnichannel data to customer responses.
• Added segment membership and VIP relationship-level filtering to List customers and Get customers count, plus customer-property-ID sorting to List customers.

​

Segments

• Added the following methods for managing segment definitions:
  • Get segment definitions
  • Create segment definition
  • Update segment definition
  • Delete segment definition

​

Sales

• Added the Abandoned Carts method.

​

Stats

• Added the Visitor Domains method.

​

Chats

• Changed Get Chat to validate access to the requested thread.
• Replaced the include_active filter with active in List Chats.
• Added the customer_id, customer_email, chat_ids, agent_types, and ecommerce_sales filters to List Archives.
• Added customer_visit to the Thread data structure.
• Added ecommerce to the Rich Message data structure.
• Added postback.ecommerce to the Message data structure.
• Changed last_event_per_type in List Chats and Login responses to reflect events from the last thread rather than the entire chat.

​

Events

• Added the System event structure.
• Added the Deleted Event structure.
• Added Send Event Preview (Web and RTM).
• Added the phone and date field types to the Filled form event.
• Added customer_property_id to the Form fields data structure.

​

Customers

• Removed Create Customer and List Customers.
• Added the Subscribe Customers and Unsubscribe Customers RTM methods.
• Renamed last_visit to visit in the Customer data structure.
• Added ticket, phone number, omnichannel, and address information to the Customer data structure.
• Added phone_number, omnichannel, and address to Update Customer.
• Added WhatsApp data to omnichannel.
• Added suggested_email to the Customer data structure.
• Added suggested_email to Update Customer.
• Added carts to the Customer data structure.
• Added cart data to the customer_updated push.
• Added customer_properties to the Customer data structure.
• Added segment_memberships to the Customer data structure.

​

Status

• Added the Update Session RTM method.

​

Bots

• Removed the X-Author-Id authorization header; bots must use Bot Authorization Tokens.

​

Pushes

• Added the role_permissions_changed reason to the agent_disconnected push.
• Added the following pushes:
  • event_deleted
  • subscribed_customers_totals_updated
  • ticket_created
  • ticket_deleted
  • customer_statistics_updated
  • thread_summary_set
  • incoming_error
  • incoming_thinking_indicator
  • customer_properties_values_updated
  • customer_property_definition_created
  • customer_property_definition_updated
  • customer_property_definition_deleted
• Added the segment_memberships_updated push.
• Added button_type, button_value, and ecommerce to Send Rich Message Postback and the incoming_rich_message_postback push.

​

Other

• Added thread summaries through Request Thread Summary and the summary response object in Get Chat, List Archives, and List Threads.
• Added Send Thinking Indicator (Web and RTM) and the incoming_thinking_indicator push.

​

Chats

• Changed last_event_per_type in the List Chats response to reflect events from the last thread rather than the entire chat.

​

Config

• Changed the Get Dynamic Configuration response to support non-LiveChat default widgets and added livechat.ai_agent_active.

​

Events

• Added the System event structure.
• Added Delete Event (Web and RTM).
• Added ecommerce to the Rich Message data structure.
• Added postback.ecommerce to the Message data structure.
• Added the phone and date field types to the Filled form event.

​

Customers

• Removed the customer_page_updated push.
• Added phone number, omnichannel, and address information to the Customer data structure.
• Added omnichannel and address to Update Customer.
• Added WhatsApp data to omnichannel.
• Added suggested_email to the Customer data structure.
• Added phone_number and suggested_email to Update Customer.
• Added customer.suggested_email to the Login RTM method.
• Added customer.address to the Login RTM response.
• Added an optional groups response field to the Update Customer Page RTM method.

​

Pushes

• Added the following pushes:
  • event_deleted
  • incoming_event_preview
  • incoming_thinking_indicator
  • incoming_welcome_message
• Added button_type, button_value, and ecommerce to Send Rich Message Postback and the incoming_rich_message_postback push.

​

Other

• Added the following methods:
  • Send Greeting Button Clicked
  • Request Welcome Message (Web and RTM)

​

Agents

• Removed avatar from Create Agent; use Update Account Organization Settings to update it.
• Removed name and avatar from Update Agent; use Update an Account for name and Update Account Organization Settings for avatar.

​

Bots

• Removed the X-Author-Id bot authorization mechanism; bots must use bot authorization tokens.
• Added type to bots.

​

Customer bans

• Added the following methods for managing customer bans:
  • List Customer Bans
  • Unban Customer

​

Greetings

• Added the following methods:
  • Create Greeting
  • Update Greeting
  • Delete Greeting
  • List Greetings
  • Get Greeting

​

Groups

• Removed the requirement for at least one agent with normal priority from Create Group.

​

Properties

• Added configurable thread summaries through the chats.auto_summary_enabled license property and Update License Properties.

​

Other

• Added the following methods:
  • Reactivate Email
  • Update Company Details

• Added requester to configuration webhooks.
• Added the following webhooks:
  • event_deleted
  • thread_summary_set
• Removed the incoming_customer webhook.

• Added the following methods:
  • Unique Visitors
  • Group Chats Count
  • Queued Visitors
  • Queued Visitors Left

​

Methods

• Added Request Welcome Message.
• Added Send Greeting Button Clicked.
• Replaced Get Predicted Agent with Request Welcome Message.

​

Events

• Added the following events:
  • incoming_welcome_message
  • incoming_thinking_indicator
  • incoming_event_preview
  • identity_changed
• Removed the customer_page_updated event.

​

Configuration

• Added tabId to init().
• Added welcomeMessageId to startChat() and resumeChat().

​

Types

• Added page and referrer to the init function types.

​

General

• Changed the SDK to use Customer API v3.5.
• Added types and constants.

​

Methods

• Removed licenseId from init(); use organizationId instead.
• Removed sendTicketForm; use the Ticketing API instead.

​

Chats

• Added the customer_countries filter to List Archives.
• Changed Get Chat to validate access to the requested thread.
• Added Get License Info (Web).
• Changed last_event_per_type in List Chats and Login responses to reflect events from the last thread rather than the entire chat.

​

Status

• Removed Change Push Notifications.
• Removed push_notifications from the Login RTM method.
• Stopped sending incoming_multicast when group statuses change.

​

Pushes

• Added the groups_status_updated push.

​

Configuration

• Added the following pushes:
  • tag_created
  • tag_deleted
  • tag_updated
• Changed the work_scheduler format in the agent_created, agent_updated, bot_created, and bot_updated pushes.

​

Chats

• Changed last_event_per_type in the List Chats response to reflect events from the last thread rather than the entire chat.

​

Status

• Added the logged_out_remotely reason to the customer_disconnected push.
• Stopped sending incoming_multicast when group statuses change.

​

Pushes

• Added the groups_status_updated push.

​

Customers

• Removed the customer_page_updated push.

​

General

• Added batch requests.

​

Agents

• Added the suspended filter to List Agents.
• Added batch request support to Create Agent, Update Agent, Delete Agent, Suspend Agent, Unsuspend Agent, and Approve Agent.
• Added account_id and last_logout to the List Agents and Get Agent responses.
• Changed the work_scheduler format in Create Agent, Update Agent, Create Bot, and Update Bot to support multiple working hours per day.

​

Bots

• Added batch request support to Create Bot, Update Bot, and Delete Bot.
• Added bot templates with the following methods:
  • Create Bot Template
  • Update Bot Template
  • Delete Bot Template
  • List Bot Templates
• Added bot authorization tokens with the following methods:
  • Issue Bot Token
  • Reset Bot Secret
  • Reset Bot Template Secret

​

Properties

• Replaced List Group Properties with List Groups Properties.

​

Tags

• Added the following methods for managing tags:
  • Create Tag
  • Delete Tag
  • List Tags
  • Update Tag

​

Other

• Added the following methods:
  • List Channels
  • Check Product Limits for Plan
  • Get Product Source
• Removed Get License ID and Get Organization ID.

• Added the following webhooks:
  • tag_created
  • tag_deleted
  • tag_updated
• Changed the work_scheduler format in the agent_created, agent_updated, bot_created, and bot_updated webhooks.
• Replaced the auto_access_added, auto_access_updated, and auto_access_deleted webhooks with auto_accesses_updated.

​

General

• Added filters.customer_countries.values, filters.customer_countries.exclude_values, and filters.customer_countries.require_every_value to all reports.

​

Tags

• Added the Tags Chat Usage method.

​

Chats

• Renamed surveys to Forms.