Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Agent Builder

Update livechat settings

Updates livechat channel settings. Requires a USER API key.

put/public/v1/agents/{agentId}/settings/livechat

Path parameters

agentIdstring required
Example:uuid-xxxx-xxxx

Request body

splitMessagesboolean required
splitCharacterLimitinteger required
conversationClose'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY' required
closeAfterinteger nullable required
timeUnit'MINUTES' | 'HOURS' nullable required
collectFeedbackboolean required
feedbackVisibility'ON_HOVER' | 'ALWAYS_VISIBLE'
feedbackTextstring nullable required
collectFeedbackReasonboolean required
includeOtherReasonboolean required
openFeedbackTextstring nullable
enableDocumentProcessingboolean
enableImageProcessingboolean
enableIdleboolean

Example request

{
  "splitCharacterLimit": 1,
  "conversationClose": "NEVER",
  "closeAfter": 1,
  "timeUnit": "MINUTES",
  "feedbackVisibility": "ON_HOVER",
  "feedbackText": "example",
  "openFeedbackText": "example",
  "feedbackReasons": [
    {
      "id": 1,
      "reason": "example"
    }
  ],
  "idleSettings": {
    "after": 1,
    "timeUnit": "MINUTES",
    "resetsLimit": 1
  }
}

Response

Updated channel settings

splitMessagesboolean required
splitCharacterLimitinteger required
conversationClose'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY' required
closeAfternumber nullable required
timeUnit'MINUTES' | 'HOURS' nullable required
collectFeedbackboolean required
feedbackVisibility'ON_HOVER' | 'ALWAYS_VISIBLE' required
feedbackTextstring nullable required
collectFeedbackReasonboolean required
includeOtherReasonboolean required
openFeedbackTextstring nullable required
enableDocumentProcessingboolean
enableImageProcessingboolean
enableIdleboolean required
conversationInterruptTimeoutinteger

Example response

{
  "splitCharacterLimit": 1,
  "conversationClose": "NEVER",
  "closeAfter": 1,
  "timeUnit": "MINUTES",
  "feedbackVisibility": "ON_HOVER",
  "feedbackText": "example",
  "openFeedbackText": "example",
  "feedbackReasons": [
    {
      "id": 1,
      "reason": "example",
      "order": 1
    }
  ],
  "idleSettings": {
    "id": 1,
    "after": 1,
    "timeUnit": "MINUTES",
    "resetsLimit": 1
  }
}