Get the List of Canned Responses
Description
You can use this API to get the list of all the available canned responses.
Query Parameters:
- limit : To specify the number of canned responses to fetch per page. The default limit is 10 and the maximum limit is 99.
- page : To specify the page number. The value starts from 1, you can increase the number as you wish to fetch the canned responses. You can set the limit to be fetched per page, if the limit is not set then the default limit(10) will be considered.
Note: If you have specified the limit as 20 then you will get 21 canned responses in the page, the extra one value indicates that there are more canned responses that can be fetched. If the canned response that you have in the portal itself is 20, then you will not receive the extra value.
- sort_by : To sort the canned responses based on usage_count or last_used_time. This should be specified along with the order.
- order : You can use ascending or descending to sort the canned responses order.
- department_id : To get the list of canned responses under the department ID
OAuth Scope:
SalesIQ.cannedresponses.READ
URL:
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/cannedresponses
Example:
Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/cannedresponses
Success Response:
Copied{
"url": "api/v2/zylker-inc/cannedresponses,
"object": "list",
"data": [
{
"modified_time": "1577979408284",
"id": "18000000096003",
"public": true,
"modifier": {
"name": "Tricia",
"id": "53400000000002073",
"type": "operator",
"image_url": "www.zylker.com/operatorimages/tricia"
},
"creator": {
"name": "Tricia",
"id": "53400000000002073",
"type": "operator",
"image_url": "www.zylker.com/operatorimages/tricia"
},
"categories": [
{
"name": "general",
"id": "18000000018001"
}
],
"usage_count": "0",
"enabled": true,
"content": "How does the refund policy work?",
"last_used_time": "",
"created_time": "1576574712749",
"associate_with_all_departments": false,
"department_id": "18000000018001"
}
]
}