Widget
Update Widget By Id
Endpoints
- Calling
- Messaging
- Conversation
- Contact
- Assistant
- Widget
- Data Source
- User
- Intent
- Prompt
- Voice
- Tool
- Form
- Channel
- Campaign
- Outbound Webhook
- Custom Field
- Provider
- Agency
- Tool Function
- Agency Billing
- Log
- Conversation Flow
- Analytics
- Tag
- Billing
- API Reference
Widget
Update Widget By Id
Update a Widget
PUT
/
api
/
v1
/
widget
/
{widget_id}
{
"message": "<string>",
"meta": {},
"data": {
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "chat",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"attributes": {},
"display_name": "<string>",
"intro_message": "<string>",
"user_opening_messages": [
"<string>"
],
"header_color": "<string>",
"user_message_color": "<string>",
"bot_message_color": "<string>",
"bot_icon_color": "<string>",
"remove_branding": true,
"ice_break_color": "<string>",
"bubble_color": "<string>",
"bubble_text": "<string>",
"bot_text_message_color": "<string>",
"user_text_message_color": "<string>",
"header_text_color": "<string>",
"textbox_default_text": "<string>",
"action_buttons": [
"<any>"
],
"action_buttons_color": "<string>",
"style_params": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_bot_icon": "<string>",
"bubble_bot_icon": "<string>",
"provider_user_friendly_label": "<string>",
"widget_provider": "<string>"
}
}
Authorizations
Your API key for authentication. You can generate it from the Settings page. Format: starts with in-
.
Path Parameters
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
{
"message": "<string>",
"meta": {},
"data": {
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "chat",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"attributes": {},
"display_name": "<string>",
"intro_message": "<string>",
"user_opening_messages": [
"<string>"
],
"header_color": "<string>",
"user_message_color": "<string>",
"bot_message_color": "<string>",
"bot_icon_color": "<string>",
"remove_branding": true,
"ice_break_color": "<string>",
"bubble_color": "<string>",
"bubble_text": "<string>",
"bot_text_message_color": "<string>",
"user_text_message_color": "<string>",
"header_text_color": "<string>",
"textbox_default_text": "<string>",
"action_buttons": [
"<any>"
],
"action_buttons_color": "<string>",
"style_params": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_bot_icon": "<string>",
"bubble_bot_icon": "<string>",
"provider_user_friendly_label": "<string>",
"widget_provider": "<string>"
}
}