Skip to main content
PUT
Update webchat configuration

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
name
string
description
string
starterMessage
string
backgroundColor
string
primaryColor
string
secondaryColor
string
icon
string | null

Set to empty string or null to remove icon

headerTextColor
string
statusText
string
statusTextColor
string
timestampColor
string
csatBackgroundColor
string
csatTextColor
string
csatThankYouMessage
string
promptId
string
allowedDomains
string[]
pipelineId
string
pipelineStage
string
initialStage
string
isAutopilot
boolean
isEnabled
boolean

Response

Webchat configuration updated

Response from POST /api/webchats and PUT /api/webchats/{id}.

data
object
required

Stored webchat configuration document. The icon field, when present, is a freshly-signed URL pointing at the R2-hosted asset (the database stores the storage key).

Example:
message
string