Update Website Chat Window Configurations
Description
You can use this API to update the chat window configurations.
URL
Copiedhttps://salesiq.zoho.com/api/v2/{screen name}/apps/{app id}/website/components/chatExample
Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/apps/32180000000014001/website/components/chatPayload
Copied{
"feedback": {
"is_enabled": "true",
"message": "feedback"
},
"show_company_logo": "false",
"allow_visitors_to_share_screen": "true",
"show_operator_image": "false",
"waiting_message": "wait",
"show_emojis": "true",
"greeting_message": "greet",
"allow_bot": "false",
"agents_offline": {
"response": "Thanks for your message, We'll get back to you shortly",
"message": "All our operaters are busy, please leave us a message and we'll get back shortly."
},
"thanking_message": "tahn yiu",
"allow_visitors_to_view_conversation": "true",
"rating": {
"1_star": "We're sorry for your experience you faced, we will reach you as soon as possible and resolve this.",
"is_enabled": "true",
"5_star": "Great! thanks for your feedback.",
"4_star": "Thank you, please share your feedback on how to improve.",
"3_star": "Thank you! We'll reach you soon and help out.",
"2_star": "We're sorry for your experience you faced, we will reach you as soon as possible and resolve this."
},
"agents_busy": {
"response": "Thanks for your message, We'll get back to you shortly",
"message": "All our operaters are busy, please leave us a message and we'll get back shortly."
},
"use_default_color": "false",
"allow_visitors_to_share_file": "false",
"size": "medium",
"fields": [
{
"name": "Name",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your name",
"index": 0,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
},
{
"name": "Email Address",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your email",
"index": 1,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
},
{
"name": "Phone",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your phone number",
"index": 2,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
}
],
"language": "default",
"color": "#238de9",
"agents_engaged": {
"response": "Thanks for your message, We'll get back to you shortly",
"message": "All our operaters are busy, please leave us a message and we'll get back shortly."
},
"allow_visitors_to_print": "false",
"theme": "2",
"allow_visitors_to_mute_sound": "false",
"allow_visitors_to_mail_transcript": "false"
}
To Update Fields:
{
"fields": [
{
"name": "Name",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your name",
"index": 0,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
},
{
"name": "Email Address",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your email",
"index": 1,
"is_mandatory": "true",
"type": "text",
"is_predefined": "true"
},
{
"name": "Phone",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your phone number",
"index": 2,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
}
]
}Success Response
Copied{
"url": "/api/v2/zylker-inc/apps/51841000003484047/website/components/chat",
"object": "chatwindow",
"data": {
"feedback": {
"is_enabled": "true",
"message": "feedback"
},
"show_company_logo": "false",
"custom_css": {
"url": "",
"is_enabled": "false",
"file_name": "zylker-img20.png"
},
"allow_visitors_to_share_screen": "true",
"show_operator_image": "false",
"waiting_message": "wait",
"modified_time": "1525711759199",
"show_emojis": "true",
"greeting_message": "Welcome to Zylker",
"allow_bot": "false",
"agents_offline": {
"response": "Thanks for your message, We'll get back to you shortly",
"message": "All our operaters are engaged, please leave us a message and we'll get back shortly."
},
"thanking_message": "Thank you for contacting Zylker!",
"allow_visitors_to_view_conversation": "true",
"rating": {
"1_star": "We're sorry for your experience you faced, we will reach you as soon as possible and resolve this.",
"is_enabled": "true",
"5_star": "Great! thanks for your feedback.",
"4_star": "Thank you, please share your feedback on how to improve.",
"3_star": "Thank you! We'll reach you soon and help out.",
"2_star": "We're sorry for your experience you faced, we will reach you as soon as possible and resolve this."
},
"agents_busy": {
"response": "Thanks for your message, We'll get back to you shortly",
"message": "All our operaters are offline, please leave us a message and we'll get back shortly."
},
"use_default_color": "false",
"allow_visitors_to_share_file": "false",
"size": "medium",
"fields": [
{
"name": "Name",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your name",
"index": 0,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
},
{
"name": "Email Address",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your email",
"index": 1,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
},
{
"name": "Phone",
"visibility": "3",
"maxlength": "30",
"is_enabled": "true",
"hint": "Enter your phone number",
"index": 2,
"is_mandatory": "false",
"type": "text",
"is_predefined": "true"
}
],
"language": "default",
"color": "#238de9",
"agents_engaged": {
"response": "Thanks for your message, We'll get back to you shortly",
"message": "All our operaters are offline, please leave us a message and we'll get back shortly."
},
"allow_visitors_to_print": "false",
"theme": "2",
"allow_visitors_to_mute_sound": "false",
"allow_visitors_to_mail_transcript": "false"
}
}