- REST API Overview
- Prerequisite
- Operators
- Portals
- Departments
- Articles
- Articles Category
- Canned Response
- Canned Response Category
- Lead Scoring Rule
- postCreate Lead Scoring Rule
- putUpdate Lead Scoring Rule Details
- putEnable/Disable Lead Scoring Rule
- deleteDelete Lead Scoring Rule
- getList Lead Scoring Rules
- getDetails of Lead Scoring Rule
- getFrequency Details of Lead Scoring Rule
- PutUpdate Frequency Details of Lead Scoring Rule
- getLead Scoring Module Fields Criteria
- Visitor Routing
- postAdd Visitor Routing Rule
- getList Visitor Routing Rule
- getVisitor Routing Rule details
- putUpdate Visitor Routing Rule Details
- putEnable/Disable Visitor Routing Rule
- putUpdate Visitor Routing Rule Order
- deleteDelete Visitor Routing Rule
- getVisitor Routing Rule Configurations
- putUpdate Common Visitor Routing Rule
- getVisitor Routing Module Fields Criteria
- Chat Routing
- Blocked IPs
- Chat Monitor
- Zobot
- Apps
- Feedback
- Tracking Preset
- Visitor History View
- Intelligent Trigger Rule
- postCreate Intelligent Trigger Rule
- getList Intelligent Trigger Rules
- getIntelligent Trigger Rule Details
- putUpdate Intelligent Trigger Rule Details
- putEnable/Disable Intelligent Trigger
- putChange Intelligent Trigger Rule Order
- deleteDelete Intelligent Trigger Rule
- getIntelligent Trigger Module Fields Criteria
- Chat
- Calls
- Visitor
- Tags
- Webhooks
- getWebhooks List
- getWebhook Details
- postCreate Webhook
- putUpdate a Webhook
- deleteDelete a Webhook
- postGenerate Public Key
- deleteDelete a Public Key
- postAdd an Event
- deleteRemove Events
- postAdd Apps
- deleteRemove Apps
- getFailed Execution List
- postRetry Failed Execution
- deleteDelete the Failed Executions
- POSTExport Failed Executions
- getWebhook Summary
- getWebhook Execution Summary
- Callbacks
- Encryptions
Response for pending action
Description
To create a pending action in the widget and update the widget with APIs. You will have to set pending as true in the following widget actions if you want to perform this action.
- banner
- section_edit
- widget_modification
- form
OAuth Scope:
SalesIQ.callbacks.UPDATE
Request Payload:
The ID will be available in the request parameter of each widget execution.
Example: request.get("id");
URL:
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/callbacks/{request_id}/widgetresponse
Example:
Copiedhttps://salesiq.zoho.com/api/v2/zylkerinc/callbacks/4fhgtd-hbnjwj-hbewjd-gyywye6/widgetresponse
Payload:
1. banner
Copied{
"type":"banner",
"status":"success",
"text":"text to be shown in a banner",
"refresh_section" : true
}
2. sections_edit
Copied{
"type":"sections_edit",
"sections":[
{
"metric":{
"layout":"metric",
"data":[
{
"label":"Allowed",
"value":"10"
},
{
"label":"Active",
"value":"6"
},
{
"label":"Total",
"value":"36",
"navigate":true,
"name":"total",
"link":"www.abc.com/1",
"link_hint":"Open ABC site - 20"
}
],
"actions":[
{
"label":"Add record",
"name":"addRecord",
"disabled":"true/false"
}
],
"title":"Users Count",
"name":"users",
"link":"",
"link_hint":""
}
}
],
"success_banner":"Data successfully updated",
"failure_banner":"Error failed to update",
"refresh_section":true
}
3. widget_modification
Copied{
"type":"widget_modification",
"success_banner":"widget section added",
"failure_banner":"widget section failed to add",
"actions":[
{
"type":"add_before",
"name":"$sectionName",
"section":{
"metric":{
"layout":"metric",
"data":[
{
"label":"Allowed",
"value":"10"
},
{
"label":"Active",
"value":"6"
},
{
"label":"Total",
"value":"36",
"navigate":true,
"name":"total",
"link":"www.abc.com/1",
"link_hint":"Open ABC site - 20"
}
],
"actions":[
{
"label":"Add record",
"name":"addRecord",
"disabled":"true/false"
}
],
"title":"Users Count",
"name":"users",
"link":"",
"link_hint":""
}
}
}
]
}
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.