Skip to main content
PUT
/
api
/
webchats
/
{id}
Update webchat configuration
curl --request PUT \
  --url https://your-instance.example.com/api/webchats/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "starterMessage": "<string>",
  "backgroundColor": "<string>",
  "primaryColor": "<string>",
  "secondaryColor": "<string>",
  "icon": "<string>",
  "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": true,
  "isEnabled": true
}
'
{}

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

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

Generic response envelope. Endpoint-specific fields are intentionally open.