REST API Overview
Prerequisite
- Generate OAuth Token
- Generate Org OAuth Token
Operators
- GetList All Operators
- PostCreate Operator
- GetOperator
- PutEdit Operator
- DeleteOperator
- PostEnable Operator
- PostDisable Operator
- PostSet Operator Status
- DeleteOperator Image
- PostAssociate Departments
- DeleteRemove Departments
Portals
- GetPortal List
- PostCreate Portal
- PutChange Portal Owner
- GetPortal
- PutEdit Portal
Departments
- GetList All Departments
- PostCreate Department
- GetDepartment
- PutEdit Department
- DeleteDepartment
- PostEnable Department
- PostDisable Department
- PostAssociate Operators
- DeleteRemove Operator
Articles
- postCreate Article
- getList All Articles
- getArticle Details
- putUpdate Article
- deleteDelete Article
Articles Category
- GETGet the list of Article Categories
- GETGet details of Article Category
- POSTCreate Article Category
- PUTUpdate Article Category
- DELETEDelete Article Category
Canned Response
- postCreate Canned Response
- getList Canned Responses
- getCanned Response Details
- putUpdate Canned Response
- deleteCanned Response
- postDelete/Move Multiple Canned Responses
Canned Response Category
- POSTCreate Canned response Category
- GETGet Canned response Category
- GETGet List of Canned response Categories
- PUTUpdate Canned response category
- DELETEDelete 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
- postAdd Chat Routing Rule
- getList Chat Routing Rules
- getGet Chat Routing Rule Details
- putUpdate Chat Routing Rule Details
- putEnable/Disable Chat Routing Rule
- putUpdate Chat Routing Rule Order
- deleteDelete Chat Routing Rule
- getChat Routing Module Fields Criteria
Blocked IPs
- postCreate Blocked IP
- putBlock/Unblock IP address
- getBlocked IPs List
- getBlocked IP address details by ID
- deleteBlocked IP address
- postComment on blocked IPs
Chat Monitor
- postCreate Chat Monitor
- putEnable/Disable Chat Monitor
- getChat Monitors List
- getChat Monitor Details by ID
- getChat Monitors Count
- DeleteDelete Chat Monitor
Zobot
- GetBots list
Apps
- GetList All Apps
- GetApp Details
- PostCreate app
- PutUpdate the App
- deleteDelete an App
- iOS Channel
- Android Channel
Feedback
- getList of Feedbacks
- getVisitor Feedback
- POSTCreate Feedback
Tracking Preset
- postAdd Tracking Preset
- getList Tracking Preset
- getTracking Preset Details
- putUpdate Tracking Preset Details
- putEnable/Disable Tracking Preset
- deletedelete Tracking Preset
- putUpdate User Preference
- getUser Preference Details
- getTracking Preset Module Criteria Fields
Visitor History View
- postCreate Visitor History View
- getList Visitor History Views
- getVisitor History View Details
- putUpdate the Details
- deleteDelete Visitor History View
- getList of Selected Views
- putUpdate Details for a Particular View Column
- getVisitor History Views Fields Criteria
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
- POSTSend Message (Operator)
- POSTSend message to latest Conversation using Visitor's Email
- PUTPick up Chat
- POSTReopen Chat
- PUTClose a Chat
- POSTExport Chat Data
- getGet Conversation details
- getGet list of conversation
- GETGet Transcript from Conversation
- GETDownload Attachment
- DeleteDelete chat
- Thread
  - GETThread
  - GETThread list
Visitor
- POSTSend Message (Visitor)
- POSTOpen Conversation
- GETGet Visitor Info
- PUTUpdate visitor info
- PUTUpdate custom info
Tags
- GetTags List
- GetTag
- PostCreate Tag
- PutUpdate Tag
- PutAdd Tags
- DeleteRemove Tag
- PostArchive Tag
- DeleteUnarchive Tag
- DeleteDelete Tag
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
- Zobot
  - postSend progress
  - postSend response
- Widgets
  - POSTSend response
Encryptions
- POSTEncrypt

Get a Canned response Category

Description

You can use this API to get a canned response category.

OAuth Scope:

SalesIQ.cannedresponses.READ

URL

Copied https://{zohosalesiq_server_uri}/api/v2/{portal_name}/cannedresponsecategories/{id}

Example

Copied https://salesiq.zoho.com/api/v2/zylker-inc/cannedresponsecategories/53400000000328033

Sample Response

Copied{
  "url": "/api/v2/zylker-inc/cannedresponsecategories/53400000000328033",
  "object": "cannedresponsecategories",
  "data": {
    "owner": "Tricia",
    "owner_id": "53400000000002001",
    "name": "Zylker Coupons",
    "created_time": "1568827989021",
   "modified_time": "1578313645056",
    "id": "53400000000328033",
    "is_default": "false"
  }
}

Get a Canned response Category

OAuth Scope:

URL

Example

Sample Response

Next steps

Features

Learning hub

Comparison

Integrations

Resources