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 '
{
  "starterMessage": "Hi! Looking for help today?",
  "isEnabled": true,
  "allowedDomains": [
    "https://example.com",
    "https://help.example.com"
  ]
}
'
{
  "message": "Webchat configuration created",
  "data": {
    "_id": "67d3a0b0c0d0e0f0a0b0c0d0",
    "name": "Marketing site widget",
    "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 | 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:
{
  "_id": "67d3a0b0c0d0e0f0a0b0c0d0",
  "organizationId": "65a0e0e0e0e0e0e0e0e0e0e0",
  "userId": "65b1f0a2c3d4e5f6a7b8c9d0",
  "createdBy": "65b1f0a2c3d4e5f6a7b8c9d0",
  "name": "Marketing site widget",
  "description": "Bottom-right widget on the marketing site",
  "starterMessage": "Hi! Looking for pricing?",
  "backgroundColor": "#FFFFFF",
  "primaryColor": "#1F2937",
  "secondaryColor": "#3B82F6",
  "icon": "https://r2.example.com/orgs/65a0.../webchat/icon.png?token=...",
  "promptId": "65b2a1c3d4e5f6a7b8c9d0e1",
  "allowedDomains": ["https://example.com"],
  "pipelineId": "66f0a0b0c0d0e0f0a0b0c0d0",
  "initialStage": "new",
  "isAutopilot": true,
  "isEnabled": true,
  "position": "bottom-right",
  "offsetX": 24,
  "offsetY": 24,
  "zIndex": 9999,
  "createdAt": "2026-03-12T10:00:00.000Z",
  "updatedAt": "2026-05-18T14:00:00.000Z"
}
​
message
string