PUT
/
api
/
v1
/
widget
/
{id}
curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/widget/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "subTitle": "<string>",
  "primaryColor": "<string>",
  "secondaryColor": "<string>",
  "primaryAIColor": "<string>",
  "secondaryAIColor": "<string>",
  "aiFirstMessage": "<string>",
  "primaryUserColor": "<string>",
  "secondaryUserColor": "<string>"
}'
{
  "id": "<string>",
  "botId": "<string>",
  "title": "<string>",
  "subTitle": "<string>",
  "headerIconFileId": "<string>",
  "primaryColor": "<string>",
  "secondaryColor": "<string>",
  "widgetIconFileId": "<string>",
  "primaryAIColor": "<string>",
  "secondaryAIColor": "<string>",
  "avatarIconFileId": "<string>",
  "aiFirstMessage": "<string>",
  "primaryUserColor": "<string>",
  "secondaryUserColor": "<string>",
  "audioVoice": "<string>",
  "voiceActive": true,
  "defaultMessages": [
    {
      "text": "<string>",
      "position": 123
    }
  ]
}

​
Parameters Description

​
id
string
required

The id of the Widget

​
title
string
required

The title of widget

​
subTitle
string
required

The subTitle of widget

​
primaryColor
string
required

The primary color of widget

​
secondaryColor
string
required

The secondary color of widget

​
primaryAIColor
string
required

The primary AI color of widget

​
secondaryAIColor
string
required

The secondary AI color of widget

​
aiFirstMessage
string
required

The AI first message of widget

​
primaryUserColor
string
required

The primary user color of widget

​
secondaryUserColor
string
required

The secondary user color of widget

​
Response Description

Below you will see the description of the widget update response

​
id
string
required

Unique identifier, must be a valid UUID.

​
botId
string

Optional ID of the bot, must be a valid UUID.

​
title
string
required

Title of the widget.

​
subTitle
string
required

Subtitle of the widget.

​
headerIconFileId
string

Optional ID of the header icon file, must be a valid UUID.

​
primaryColor
string
required

Primary color configuration for the widget.

​
secondaryColor
string
required

Secondary color configuration for the widget.

​
widgetIconFileId
string

Optional ID of the widget icon file, must be a valid UUID.

​
primaryAIColor
string
required

Primary AI color setting.

​
secondaryAIColor
string
required

Secondary AI color setting.

​
avatarIconFileId
string

Optional ID of the avatar icon file, must be a valid UUID.

​
aiFirstMessage
string
required

First message displayed by the AI.

​
primaryUserColor
string
required

Primary user color configuration.

​
secondaryUserColor
string
required

Secondary user color configuration.

​
audioVoice
string

Optional audio voice setting.

​
voiceActive
boolean

Indicates if voice functionality is active (optional).

​
defaultMessages
array

List of default messages for the widget.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.