Update the App
Description
You can use this API to update the app.
OAuth Scope:
SalesIQ.apps.UPDATE
Requested Payload:
- name : To specify the name of the app
- departments : To specify the departments with which the App is going to be mapped .
- description : To specify the description of the app
- business_hours : To enable the business hours option by acknowledging your availability and give your customers a better sense of when they can expect a personal response to their chat requests. To know more, click here. (Values: true/false)
- privacy : To enable privacy by implementing the GDPR options. To know more, click here. (True/False)
- enabled: To specify the enabled/disabled status of the App (True/False)
- waiting_time : To specify the visitor waiting_time before the operator accepts the chat. (Values: 30/45/60/90/120)
- mail_transcript : To specify if the chat transcript is mailed to the visitor or not. (True/False)
- share_file : To specify if the visitor can share files in the chat window. (True/False)
- show_emojis : The visitor can use emojis during the chat session. (True/False)
- share_screen : To specify if the visitor can initiate screen share or not. (True/False)
- view_conversation : To specify if the visitor can view his/her previous conversations with the operators. (True/False)
- language : To specify the language in which the chat window appears. If no language is specified, it takes the website's language.
- contact : To specify the details of the visitor with which the operators can communicate further.
- address: To specify the address of the visitor.
- email: To specify the email address of the visitor.
- enabled: To specify if the contact field is enabled or not for the visitor.
- name: To specify the name of the visitor.
- phone number: To specify the phone number of the visitor.
- notify_terms : To specify if the privacy policy is enabled/disabled for website visitors.
- link_content : To provide content for the link in the GDPR banner.
- notify_cookies : To specify if cookies are enabled or not to store visitor's details.
- link_url : To provide URL for the link content. On clicking the link content, it will take to the specified URL.
- font : To provide the font selected for the chat window.
- banner_content : To provide content to be displayed on the GDPR banner.
- color : To provide color in which the content will be displayed.
- button text : To provide text for button.
URL
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/apps/{app id}
Example
Copiedhttps://salesiq.zoho.com/api/v2/zylkerinc/apps/41000000003001
Payload
Copied{
"name": "zylker",
"departments": [
"46000000000017"
],
"business_hours": false,
"privacy": false,
"description": {
"default": "How do you do?"
},
"enabled": true,
"waiting_time": "60",
"mail_transcript": true,
"share_file": true,
"show_emojis": true,
"share_screen": true,
"view_conversation": true,
"language": "default",
"contact": {
"address": "",
"email": "",
"enabled": true,
"name": "",
"phonenumber": ""
},
"notify_terms": "1",
"link_content": "",
"notify_cookies": "1",
"link_url": "",
"banner_content": "",
"color": "#0066cc",
"button_text": {
"text2": "",
"text1": ""
}
}
Success Response
Copied{
"url": "/api/v2/zylkerinc/apps/41000000003001",
"object": "app",
"data": {
"reply_time": "0",
"modified_time": "1570686177009",
"view_conversation": true,
"link_content": "",
"waiting_time": "60",
"created_time": "1570686175719",
"button_text": {
"text2": "",
"text1": ""
},
"enabled": true,
"unique_name": "zylkerinc",
"name": "zylker",
"contact": {
"address": "",
"enabled": true,
"email": "",
"name": "",
"phonenumber": ""
},
"description": {
"default": "How do you do?"
},
"link_url": "",
"notify_cookies": {
"url": "",
"code": "1"
},
"hide_when_offline": false,
"mail_transcript": true,
"offline_content": {
"sub_header": "",
"action": "",
"header": ""
},
"language": "default",
"creator": {
"name": "Patricia",
"id": "46000000000005"
},
"share_screen": true,
"seasonaltheme_enabled": false,
"color": "#0066cc",
"widget_type": "float",
"notify_terms": "1",
"logo_url": "",
"share_file": true,
"online_content": {
"sub_header": "",
"action": "",
"header": ""
},
"business_hours": false,
"id": "41000000003001",
"show_emojis": true,
"departments": [
{
"46000000000017": "zylkerinc"
}
],
"channels": {
"website": {
"faq": 1,
"chat": 1,
"enabled": true,
"proactive": 1,
"call": 1
},
"emailsignature": {
"faq": 1,
"chat": 1,
"enabled": true,
"proactive": 1,
"call": 1
}
},
"widgetcode": "52d275f1b450513bb93093c194a70929dd37b5afeef0ad02b8f95c5a7a6d632d",
"banner_content": "",
"privacy": false
}
}