Skip to main content
PUT
/
api
/
organizations
/
{organizationId}
/
webchat-settings
Update webchat settings
curl --request PUT \
  --url https://your-instance.example.com/api/organizations/{organizationId}/webchat-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "showSenderNameInWebchat": true,
  "aiAssistantName": "Acme Assistant"
}
'
{
  "success": true,
  "message": "Webchat settings updated",
  "data": {
    "showSenderNameInWebchat": true,
    "aiAssistantName": "Acme Assistant"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required

Body

application/json
​
showSenderNameInWebchat
boolean

When true, webchat reveals the sender name on each message (agent persona name for humans, the configured assistant name for autopilot).

​
aiAssistantName
string

Display name shown for AI/autopilot messages in webchat; falls back to "AI Assistant" when empty.

Response

Webchat settings updated

​
success
boolean
​
message
string
​
data
object