Skip to product menu
Skip to main content

Update a Canned Response

Description

You can use this API to update 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 content for the canned response.
  • enabled: To specify the enabled/disabled status of the canned response (True/False)
  • 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.

OAuth Scope:

SalesIQ.cannedresponses.UPDATE

URL:

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/cannedresponses/{id}

Example:

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

Payload:

Copied{
  "content": "How does the refund policy work?",
  "associate_with_all_departments": "true",
  "enabled": true,
  "public": "true",
  "category_ids": [
    "18000000018001"
  ]
}

Success Response:

Copied{
  "url": "api/v2/zylker-inc/cannedresponses/18000000096003",
  "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 does the refund policy work?",
    "last_used_time": "",
    "created_time": "1576574712749",
    "associate_with_all_departments": true
  }
}