Zoho Support, a helpdesk software application, provides Application Programming Interfaces (APIs) to all its partners, customers and developers. Using APIs, you can integrate Zoho Support modules with other Zoho services, third-party applications, portals or Web sites and customize them as required. You can extract Zoho Support data in XML or JSON format. Our APIs are available across all editions.
Zoho Support provides the following API methods:
| Name | Description |
| getrecords | To get records from Zoho Support |
| addrecords | To add records to Zoho Support |
| updaterecords | To update records in Zoho Support |
| deleterecords | To delete records from Zoho Support |
The usage of API is limited by number of calls under different editions available in Zoho Support.
| Edition | API Requests |
| Free | 250 calls per day / Organization |
| Express | 250 calls per day / user license or a max limit of 5000 calls per day / Organization |
| Professional | 250 calls per day / user license or a max limit of 5000 calls per day / Organization |
| Enterprise | 250 calls per day / user license or a max limit of 15,000 calls per day/ Organization |
Copy the API key that is generated. You will require this key to integrate Zoho Support with other third-party services.
While initiating API requests, you must pass the ticket parameter (encrypted alphanumeric string) to authenticate the user credentials with Zoho. To generate a ticket for a particular user, you need to send an authenticated HTTPS POST request over a secured connection to Zoho Accounts.
Give the username and password of Admin role
Sample form POST format with supported parameters:
The mandatory parameters along with their values are:
| Parameters | Type | Description |
| servicename* | ZohoSupport | Specify the service name is ZohoSupport. |
| FROM_AGENT* | Boolean | True |
| LOGIN_ID* | String | User's Zoho ID or Email |
| Password* | String | Password for the Zoho ID |
Depending on the parameters passed, you will get a response in the format given below:
# #Sun Oct 24 05:42:49 PDT 2010 GETUSERNAME=null WARNING=null PASS_EXPIRY=39 TICKET=ffggg879e131606d0c3ab71182db704d RESULT=TRUE
| Parameters | Type | Description |
| Comment | String | Ticket generated date & time |
| GETUSERNAME | - | - |
| WARNING | String | If the parameters are found to be incorrect, the user will get a warning message stating the same otherwise the value will be null. |
| PASS_EXPIRY | String | Displays duration of the password expiry. You will get the value as -1, if the password expiry is not set for your Zoho account. |
| TICKET | String | Ticket generated for the request (32 characters) |
| RESULT | Boolean | Value is TRUE if the ticket is generated successfully, else it is FALSE. |
Example 1: Successful Ticket Generation Pattern
# #Sun Oct 24 05:42:49 PDT 2010
GETUSERNAME=null
WARNING=null
PASS_EXPIRY=39
TICKET=ff075878e131606d0c3ab71182db704d
RESULT=TRUE
Example 2: Failure Ticket Generation Pattern
# #Thu Apr 01 20:34:34 PDT 2010
CAUSE=Username and Password do not match
RESULT=FALSE
Important Notes:
