Create a Canned Response

Description

You can use this API to create a canned response.

Requested Payload:

  • department_id: To specify the department ID with which the canned response should be mapped. This field is mandatory, if the associate_with_all_departments is set to False.
  • content: To specify the content for the canned response.
  • associate_with_all_departments : To specify if the canned response is associated with all the available departments.
  • public (true | false) : If the key is set to false, the canned response is private and only visible to the operator who created it. If the key is set to true, the canned response will be visible to all operators across all departments.
  • category_ids : To specify the category IDs with which the category should be mapped. If the category_id is not given, the canned response will be created in the default general category.

OAuth Scope:

cannedresponses.CREATE

URL:

Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screenname}/cannedresponses

Example:

Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/cannedresponses

Payload:

Copied{
  "content": "How to Apply Zylker Promo/Coupon code?",
  "department_id": "19000000000017", 
  "associate_with_all_departments":"true",
  "public":"true",
  "category_ids":["18000000018001"]
}

Success Response:

Copied{
    "url": "api/v2/zylker-inc/cannedresponses",
    "object": "cannedresponse",
    "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 to Apply Zylker Promo/Coupon code?",
        "last_used_time": "",
        "created_time": "1576574712749",
        "associate_with_all_departments": true
    }
}