Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Agent Builder

Update whatsapp settings

Updates whatsapp channel settings. Requires a USER API key.

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

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
enableDocumentProcessingboolean
enableImageProcessingboolean
debounceboolean
debounceTimeinteger
enableIdleboolean
conversationInterruptTimeoutinteger
conversationInterruptTimeUnit'MINUTES' | 'HOURS'
sendCloseMessageboolean
closeMessageType'STATIC' | 'DYNAMIC'
closeMessagestring nullable
closeInstructionstring nullable
autoReplyOnUninterruptboolean

Example request

{
  "splitCharacterLimit": 1,
  "conversationClose": "NEVER",
  "closeAfter": 1,
  "timeUnit": "MINUTES",
  "idleSettings": {
    "after": 1,
    "timeUnit": "MINUTES",
    "resetsLimit": 1
  },
  "conversationInterruptTimeUnit": "MINUTES",
  "closeMessageType": "STATIC",
  "closeMessage": "example",
  "closeInstruction": "example"
}

Response

Updated channel settings

splitMessagesboolean required
splitCharacterLimitinteger required
conversationClose'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY' required
closeAfterinteger nullable required
timeUnit'MINUTES' | 'HOURS' nullable required
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,
  "conversationClose": "NEVER",
  "closeAfter": 1,
  "timeUnit": "MINUTES",
  "idleSettings": {
    "id": 1,
    "after": 1,
    "timeUnit": "MINUTES",
    "resetsLimit": 1
  },
  "conversationInterruptTimeUnit": "MINUTES",
  "closeMessageType": "STATIC",
  "closeMessage": "example",
  "closeInstruction": "example"
}