Skip to main content
POST
/
api
/
webchats
Create webchat configuration
curl --request POST \
  --url https://your-instance.example.com/api/webchats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "backgroundColor": "<string>",
  "primaryColor": "<string>",
  "secondaryColor": "<string>",
  "promptId": "<string>",
  "allowedDomains": [
    "<string>"
  ],
  "initialStage": "<string>",
  "description": "<string>",
  "starterMessage": "<string>",
  "icon": "<string>",
  "headerTextColor": "<string>",
  "statusText": "<string>",
  "statusTextColor": "<string>",
  "timestampColor": "<string>",
  "csatBackgroundColor": "<string>",
  "csatTextColor": "<string>",
  "csatThankYouMessage": "<string>",
  "pipelineId": "<string>",
  "pipelineStage": "<string>",
  "isAutopilot": true,
  "isEnabled": true
}
'
{}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
backgroundColor
string
required
primaryColor
string
required
secondaryColor
string
required
promptId
string
required
allowedDomains
string[]
required
initialStage
string
required
description
string
starterMessage
string
icon
string
headerTextColor
string
statusText
string
statusTextColor
string
timestampColor
string
csatBackgroundColor
string
csatTextColor
string
csatThankYouMessage
string
pipelineId
string
pipelineStage
string
isAutopilot
boolean
isEnabled
boolean

Response

Webchat configuration created

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