Skip to content

POST
/api/v1/workspaces/{workspace_id}/widget-config
workspace_id
required
string

The ID of the workspace.

Example
01kxb0t5c4ccf16vp1qt0y0mer
object
allowed_origins

Must be a valid URL. Must not be greater than 255 characters.

Array<string>
[
"b"
]
pre_chat_fields
Array<object>
object
key
required

Must not be greater than 40 characters.

string
d
label
required

Must not be greater than 80 characters.

string
l
type
required
string
Allowed values: text email tel
tel
required
boolean
theme
object
color

Must match the regex /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/.

string
nullable
#eEd
primary

Must match the regex /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/.

string
nullable
#eEd
primaryText

Must match the regex /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/.

string
nullable
#eEd
launcher

Must match the regex /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/.

string
nullable
#eEd
position
string
nullable
Allowed values: left right
right
branding_enabled
boolean
true
accepting_chats
boolean
proactive_rules

Must not have more than 20 items.

Array<object>
object
url_pattern
required

Must not be greater than 255 characters.

string
j
delay_seconds
required

Must be at least 0. Must not be greater than 3600.

integer
17
message
required

Must not be greater than 500 characters.

string
i