v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Agent Builder

Get all agent channel settings

Returns livechat, WhatsApp, Instagram, and Messenger channel settings.

get/public/v1/agents/{agentId}/settings

Path parameters

agentIdstring required
Example:uuid-xxxx-xxxx

Response

Channel settings

Example response

{
  "liveChat": {
    "splitCharacterLimit": 1,
    "closeAfter": 1,
    "timeUnit": "MINUTES",
    "conversationClose": "NEVER",
    "feedbackVisibility": "ON_HOVER",
    "feedbackText": "example",
    "openFeedbackText": "example",
    "feedbackReasons": [
      {
        "id": 1,
        "reason": "example",
        "order": 1
      }
    ],
    "idleSettings": {
      "id": 1,
      "after": 1,
      "timeUnit": "MINUTES",
      "resetsLimit": 1
    }
  },
  "whatsApp": {
    "splitCharacterLimit": 1,
    "closeAfter": 1,
    "timeUnit": "MINUTES",
    "conversationClose": "NEVER",
    "idleSettings": {
      "id": 1,
      "after": 1,
      "timeUnit": "MINUTES",
      "resetsLimit": 1
    },
    "conversationInterruptTimeUnit": "MINUTES",
    "closeMessageType": "STATIC",
    "closeMessage": "example",
    "closeInstruction": "example"
  },
  "instagram": {
    "splitCharacterLimit": 1,
    "closeAfter": 1,
    "timeUnit": "MINUTES",
    "conversationClose": "NEVER",
    "idleSettings": {
      "id": 1,
      "after": 1,
      "timeUnit": "MINUTES",
      "resetsLimit": 1
    },
    "conversationInterruptTimeUnit": "MINUTES",
    "closeMessageType": "STATIC",
    "closeMessage": "example",
    "closeInstruction": "example"
  },
  "messenger": {
    "splitCharacterLimit": 1,
    "closeAfter": 1,
    "timeUnit": "MINUTES",
    "conversationClose": "NEVER",
    "idleSettings": {
      "id": 1,
      "after": 1,
      "timeUnit": "MINUTES",
      "resetsLimit": 1
    },
    "conversationInterruptTimeUnit": "MINUTES",
    "closeMessageType": "STATIC",
    "closeMessage": "example",
    "closeInstruction": "example"
  }
}