v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Agent Builder

Get whatsapp settings

Returns whatsapp channel settings for an agent.

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

Path parameters

agentIdstring required

Example:uuid-xxxx-xxxx

Response

Channel settings

splitMessagesboolean required

splitCharacterLimitinteger required

closeAfternumber nullable

timeUnit'MINUTES' | 'HOURS' nullable

conversationClose'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY' nullable

enableDocumentProcessingboolean

enableImageProcessingboolean

debounceboolean

debounceTimeinteger

enableIdleboolean required

conversationInterruptTimeoutinteger

conversationInterruptTimeUnit'MINUTES' | 'HOURS' nullable

sendCloseMessageboolean required

closeMessageType'STATIC' | 'DYNAMIC' required

closeMessagestring nullable

closeInstructionstring nullable

autoReplyOnUninterruptboolean

Example response

{
  "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"
}