Zoho Desk APIs facilitate integration with other Zoho applications and third-party tools by adhering to RESTful principles. These APIs enable you to programmatically fetch and edit data in the different modules in Zoho Desk, such as Tickets, Contacts, Accounts and so on. All the APIs follow HTTP rules and error codes. To keep yourself updated about the changes in our APIs, follow the Zoho Desk Developer APIs forum.
API Root Endpoint
desk.zoho.com/api/v1
All Zoho Desk APIs require these two mandatory fields in the header.
Authorization - Authentication request tokenorgId -ID of the organization to access. All API endpoints except /organizations mandatorily require the orgId.Example
$ curl -X GET https://desk.zoho.com/api/v1/tickets
-H "orgId:2389290"
-H "Authorization:Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"
Zoho Desk APIs enable data manipulation and retrieval through different HTTP methods.
| Method | Purpose |
|---|---|
| GET | Retrieve resources |
| POST | Create resources and perform resource actions |
| PUT | Update resources |
| PATCH | Partially update resources |
| DELETE | Delete resources |
Using the GET method, you can get a list of resources or details of a particular instance of a resource.
To get a list of tickets
$ curl -X GET https://desk.zoho.com/api/v1/tickets
-H "orgId:2389290"
-H "Authorization:Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"
To get the details of a ticket referred to by a specified ticket_id
$ curl -X GET https:// desk.zoho.com/api/v1/tickets/903000000000099
-H "orgId:2389290"
-H "Authorization:Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"
Zoho Desk uses HTTP status codes to indicate success or failure of API calls. Status codes in the 2xx range indicate success, 4xx range indicate error in the information provided, and 5xx range indicate server side errors. The following table lists some commonly used HTTP status codes.
| Status Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 204 | No content |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden (Unauthorised access) |
| 404 | URL not found |
| 405 | Method not allowed (Method called is not supported for the API invoked) |
| 413 | Payload Too Large |
| 415 | Unsupported Media Type |
| 422 | Unprocessable Entity |
| 429 | Too Many Requests |
| 500 | Internal error |
Besides HTTP status codes and their corresponding error messages, error responses for Zoho Desk APIs also include a machine-parsable errorCode param to simplify error handling.
The different errorCodes and their uses are described below.
This errorCode value appears if the authentication token in the API request is invalid
This errorCode value appears if the OAuthToken is invalid or expired.
This errorCode value appears if the OAuthToken does not contain the scope required to perform the operation.
This errorCode value appears if the user chooses a different organization while generating the OAuthToken instead of the organization in which they want to perform the operation.
This errorCode value appears if the user does not have all the permissions required to access the resource.
This errorCode value appears if the user is unable to perform an action due to the limitations of the Zoho Desk edition in use
The possible values for the feature key are
AGENTSLIGHT_AGENTSTEAMThe possible values for the editionType key are
FREEEXPRESSSTANDARDPROFESSIONALENTERPRISEULTIMATEThis errorCode value appears if the URL provided is invalid or does not exist.
This errorCode value appears if the method in the API request is known by the server but disabled for the API requested.
This errorCode value appears if the size of the resource exceeds the limit defined by the server.
This errorCode value appears if the server refuses the request as a result of receiving the input in an unsupported format.
This errorCode value appears if there are inaccuracies, such as duplicate entries or invalid IDs, in the data given by the user. The type of inaccuracy is identified by the errorType param.
The possible values for the errorType key are:
The field that contains the inaccurate value is returned in the fieldName param, which is represented in the JSON Pointer convention
This errorCode value appears if the input does not fulfil the conditions necessary for successfully executing the API.
This errorCode value appears if the API request tries to remove the last user remaining in a department that has live chat enabled
This errorCode value appears if the user creates a contract for an SLA with existing or overlapping time periods.
This errorCode value appears when the Extension API fails to process a request due to an exception received from an external service such as Sigma, DRE, or the Marketplace.
The errorDetails provide information about the source and cause of the failure:
This errorCode value appears if the API request tries to deactivate a user who has enabled integrations in the help desk portal
The integration param returns the integration the user enabled in the portal. The possible values are :
LIVECHATThis errorCode value appears if the user sends too many requests within a given amount of time ("rate limiting").
This errorCode value appears if the user fires too many requests in a simultaneous/concurrent manner ("rate limiting").
This errorCode value appears if the server encounters an unexpected condition that prevents it from fulfilling the request.
Request Example
$ curl -X GET https://desk.zoho.com/api/v1/tickets/700000007942
-H "orgId:2389290"
-H "Authorization:Zoho-oauthtoken 1000.3d0a155402dbb59f776fd63adb1e67c0.a41ea557a6a8d7e402690098b2056f60"
Response Example
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
UnAuthenticatedErrorResponse
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
Oauth Error Response
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
ScopeMisMatch Error Response
HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
OAuth Org Mismatch Error Response
HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
Forbidden Error Response
HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
LicenseAccessLimited Error Response
HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
Url Not Found Error Response
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Method Not Allowed Error Response
HTTP/1.1 405 Method Not Allowed
Content-Type: application/json;charset=UTF-8
Resource Size Exceeded Error Response
HTTP/1.1 413 Payload Too Large
Content-Type: application/json;charset=UTF-8
Unsupported Media Type Error Response
HTTP/1.1 415 Unsupported Media Type
Content-Type: application/json;charset=UTF-8
Invalid Data Error Response
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json;charset=UTF-8
Unprocessable Entity Error Response
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json;charset=UTF-8
Unprocessable Entity Error Response
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json;charset=UTF-8
Unprocessable Entity Error Response
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json;charset=UTF-8
Unprocessable Entity Error Response
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json;charset=UTF-8
Unprocessable Entity Error Response
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json;charset=UTF-8
Threshold Exceeded Error Response
HTTP/1.1 429 Too Many Requests
Content-Type: application/json;charset=UTF-8
Concurrent Rate Limit Exceeded Error Response
HTTP/1.1 429 Too Many Requests
Content-Type: application/json;charset=UTF-8
Internal Server Error Response
HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
In Zoho Desk, you can fetch multiple resources using listing APIs, such as list tickets , list agents and list departments and so on. The retrieval and arrangement of these resources on end-users' screen is called pagination. Pagination in listing APIs is made possible by two parameters: from and limit
| Attributes | Description |
|---|---|
| from | from indicates the offset from which the records is to be fetched the default value of from parameter is 1 |
| limit | limit indicates the number of records the API must fetch. The default value of limit will be 10. A single API request can fetch a maximum of 50 resources. However, some APIs support higher limits, which is mentioned in the API document, wherever applicable |
The paginated responses are retrieved in the form of JSON objects that contain a key called data and a JSON array of resources (objects) as the value.
Request Example with pagination
$ curl -X GET 'https://desk.zoho.com/api/v1/accounts?from=1&limit=1'
-H "orgId:2389290"
-H "Authorization:Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"
-H "featureFlags:multiLayout,ticketTeam"
Response Example:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"data" : [ {
"website" : "112121",
"accountName" : "Admin Account",
"phone" : "121212",
"webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
"createdTime" : "2015-02-16T16:57:44.000Z",
"zohoCRMAccount" : {
"id" : "32754000000537001"
},
"customerHappiness" : {
"badPercentage" : "30",
"okPercentage" : "30",
"goodPercentage" : "40"
},
"id" : "1892000000052077",
"email" : "admin@zylker.com"
} ]
}Zoho Desk enables you to retrieve different related resources through a single API request, which is made possible by the include query param. This query param takes a comma separated list of values corresponding to the API.
Backwards Compatibility on api changes is always maintained. Minor api changes like field, URL, query param deprecation will be notified via forum with a transistion period. Support will be revoked after the end of transition period. Only major api interface change will involve the version number in the URL to change.
An OpenAPI Specification (OAS) is an industry-standard way to describe RESTful APIs. It provides a clear, structured way to define authentication methods, endpoints, request parameters, and response formats. OpenAPI specification is written either in JSON or YAML, making them both machine-readable and easy for developers to interpret.
OpenAPI 3.1.0 provides a standardized and structured approach that helps developers understand, use, and integrate APIs more effectively. It is designed to provide:
The OpenAPI Specification (OAS) for Zoho Desk APIs is hosted on GitHub:
Zoho Desk's OAS files are designed to provide a generic representation of standard API endpoints, request/response structures, and supported HTTP methods. They do not include application-specific business logic.
For example, each module may require different input data for specific scenarios. However, the generic design may not fully capture your application-specific requirements. Developers are expected to identify such gaps, plan accordingly, and extend or adapt the specifications to fit their use cases during integration.
Every time you make an API call in Zoho Desk, it uses up API credits. These credits help control usage and ensure system performance stays stable.
The number of credits used depends on what kind of operation you're performing. Simple actions use fewer credits, while complex actions use more.
Every Zoho Desk edition comes with a set of base credits by default. Additional credits are also provided based on the number of users you have purchased, excluding light agents.
| Edition | Base Credits + Additional Credits per User |
|---|---|
| Free/ Trial period | 5,000 + 0 |
| Express | 25,000 + 100/User |
| Standard | 50,000 + 250/User |
| Professional | 75,000 + 500/User |
| Enterprise/Zoho One/CRM Plus | 100,000 + 1,000/User |
For example, if a portal is using the Professional edition and has 50 users.
Here is a calculator to find the available credit limits based on your edition and the number of users.
API credits are tracked on a 24-hour cycle, from 00:00 to 23:59:59, based on the timezone of your data center. These credits reset every 24 hours.
Once you have used up all your base and user credits, you can purchase additional credits
Note:Unused credits will expire after the 24-hour period ends.
You can view the daily base credits available to your organization by navigating to Setup > Developer Space > APIs.
You can easily track your credit usage by checking this section. It provides a detailed breakdown showing how many credits have already been consumed and how many are still available for use.
Note:API credit usage is presented for the current day. Please allow up to 15 minutes for the latest usage information to be updated.
In addition to API credits, Zoho Desk also uses a concurrency system to manage API usage. Concurrency limits define the maximum number of API calls that can be active at the same time from a portal
These limits differ based on your Zoho Desk edition.
| Edition | Concurrency Limits |
|---|---|
| Free/ Trial period | 5 |
| Express | 10 |
| Standard | 10 |
| Professional | 15 |
| Enterprise/Zoho One/ CRM Plus | 25 |
If you exceed the allowed concurrency limit, you will receive an error message, as shown
In such cases, you can terminate (kill) some ongoing API calls to continue.
Since concurrency is based on the number of simultaneous active calls, each active API call still consumes credits as usual.
You can make as many API calls as needed per minute, as long as the number of active calls at any given time stays within your editions concurrency limits.
Error response
{
"errorCode": "TOO_MANY_REQUESTS",
"message": "The maximum number of Concurrent API Calls that can be made has been exceeded."
}
Desk uses two types of credit consumption models depending on the nature of the API
The number of credits consumed remains fixed, regardless of how much data is processed.
API: Fetch a single record
Credit: 1 credit/ call
This credit consumption depends on how many records you are working with or how intensive the operation is.
When adding, updating, or deleting multiple records in a single API request, credits are consumed based on the number of records processed.
Simply, More records = More credits used
Each API has a defined configured credit value, and the total credit consumption is calculated using a formula
| Operation | Defined credit |
|---|---|
| Update multiple records | 1 credit for every 2 records |
| Delete multiple records (Move records to trash) | 6 credits per record |
| Restore records from the recycle bin | 6 credits per record |
| Execute generic action | 1 credit per record Note: If the record ID is not specified, 50 credits will be consumed by default. |
For example, updating 50 records will use 25 credits. Restoring 50 records from the recycle bin will consume 300 credits.
When you fetch multiple records, credits are consumed based on the range of records retrieved. The larger the range, the more credits are used. This applies to APIs that search for or fetch a large number of records. The credit usage increases with the number of records processed.
For example, if an API is invoked with parameters from=5 and limit=50, it will retrieve 50 records starting from index 5 (i.e., records 5 to 54). Since these records are near the beginning of the dataset, the operation is lighter and will consume around 3 credits.
However, fetching the same number of records from a much later point. For example, from index 10,005 to 10,054 is more resource-intensive and may consume up to 50 credits.
All APIs support a maximum of 50 records per request. The deeper the data range, the higher the credit consumption.
Note:Fetching a record by its ID or number (e.g., Ticket ID or Ticket Number) counts as a single record. Only one credit will be consumed.
In Zoho Desk, you can increase your API credits beyond the base credits provided with your edition. To do this, simply send an email to support@zohodesk.com, or contact your dedicated account manager and they will take care of the rest.
Note:Credit purchase limits vary by edition. The editions (excluding Free and Trial) allow up to 5,000,000 credits, including base and user credits.
Before You Request Additional Credits, Make Sure
The table below shows the pricing for each credit slab.
| Tier | Daily credit Range | Monthly Rate per 1000 credits |
|---|---|---|
| First 25,000 | 1 to 25,000 | $4.20 |
| Next 75,000 | 25,001 to 100,000 | $1.80 |
| Next 150,000 | 100,001 to 250,000 | $1.50 |
| Above 250,000 | 250,001+ | $0.75 |
Example: Calculating Monthly Cost for 300,000 Credits
If you need 300,000 credits in a day, the monthly cost would be:
Total Monthly Cost: $502.50
Use the calculator below to check the monthly payable amount for the add-on credits.
Disclaimer: All calculated rates are approximate and subject to changes in the exchange rate.
You can track how many API credits are used and how many are remaining by checking the response headers of your API call.
| Response Header Name | Description |
|---|---|
| X-Rate-Limit-Request-Weight-v3 | The number of credits used for that specific API call. |
| X-Rate-Limit-Remaining-v3 | The credits left for portal for the current day. |
| Retry-After | The time (in seconds) you need to wait before trying the next API request. This appears in the response header only after you reach the rate limit. |
Note:The Retry-After header appears only when your portal hits the maximum daily credit limit.
Success Response Header
HTTP/1.1 200 OK
-H "X-Rate-Limit-Request-Weight-v3: 3"
-H "X-Rate-Limit-Remaining-v3: 950"
Too many request Response Header
HTTP/1.1 429
-H "Retry-After: 34"
You can set up alert notifications to stay informed about your API credit usage. By specifying a threshold limit in percentage, the system will automatically trigger an alert when your API usage reaches that defined limit. This helps you proactively manage your consumption and avoid unexpected disruptions. Learn how to configure API usage alerts.
Zoho Desk APIs use OAuth 2.0 for authentication. This page gives you an overview of the authentication process. For complete details on OAuth 2.0 flows, registration, token management, and more, refer to Zoho OAuth 2.0 documentation.
To access Zoho Desk APIs, your application needs an access token obtained through one of the OAuth 2.0 flows. At a high level, the steps are:
Register your application in the Zoho API console.
Get consent from the user to access their data and obtain an access token.
Call Zoho Desk APIs using the access token.
Token expiry: Access tokens expire periodically. The expiry duration is mentioned as expires_in (seconds) in the access token response. To maintain uninterrupted access, you can request for an optional refresh token, store it, and use it to generate new access tokens as needed.
Different OAuth flows for different app types: Zoho supports OAuth flows for different application types (server-based, client-based, mobile & desktop-based, limited input devices, and self client). You can choose the flow that matches your application.
Multi DC support: Zoho operates data centers in multiple regions. If your application serves users across regions, you must enable Multi DC support in the API console and use region-specific endpoints for both OAuth and Product API calls.
Sample Access Token Response
Zoho Desk APIs require OAuth scopes to define the level of access your application needs. When requesting for an access token, request only the scopes your application requires. These will be displayed to the users when asking for consent.
The various scopes accessible using Zoho Desk's APIs are as follows:
| ScopeName | Description |
|---|---|
| Desk.tickets.ALL | Grants read and write access to tickets and related data. |
| Desk.tickets.READ | Grants read access to tickets and related data. |
| Desk.tickets.WRITE | Grants write access to tickets. |
| Desk.tickets.UPDATE | Grants update access to tickets and related data. |
| Desk.tickets.CREATE | Grants access to create tickets |
| Desk.tickets.DELETE | Grants access to delete tickets |
| Desk.contacts.READ | Grants read access to contacts, accounts and related data |
| Desk.contacts.WRITE | Grants write access to contacts, accounts and related data |
| Desk.contacts.UPDATE | Grants update access to contacts, accounts and related data |
| Desk.contacts.CREATE | Grants access to create contacts and accounts |
| Desk.tasks.ALL | Grants read and write access to tasks and related data |
| Desk.tasks.WRITE | Grants write access to tasks and related data |
| Desk.tasks.READ | Grants read access to tasks and related data |
| Desk.tasks.CREATE | Grants access to create tasks |
| Desk.tasks.UPDATE | Grants update access to tasks and related data |
| Desk.tasks.DELETE | Grants access to delete tasks |
| Desk.basic.READ | Grants read access to basic data, such as organizations, agents and departments |
| Desk.basic.CREATE | Grants access to create basic data, such as organizations, agents and departments |
| Desk.search.READ | Grants access to search for data |
| Desk.events.ALL | Grants read and write access to the events subscription |
| Desk.events.READ | Grants read access to the events subscription |
| Desk.events.WRITE | Grants write access to the events subscription |
| Desk.events.CREATE | Grants access to create events subscription |
| Desk.events.UPDATE | Grants update access to the events subscription |
| Desk.events.DELETE | Grants delete access to the events subscription |
| Desk.articles.READ | Grants read access to articles |
| Desk.articles.CREATE | Grants access to create articles |
| Desk.articles.UPDATE | Grants update access to articles |
| Desk.articles.DELETE | Grants delete access to articles |
To request multiple scopes, separate them with commas:
scope=Desk.tickets.READ,Desk.basic.READ
For more details about scope format, see OAuth Scopes.
To authenticate your API calls, include the access token in the Authorization header of every API request.
Authorization: Zoho-oauthtoken {access-token-value}
Authorization: Bearer {access-token-value}
curl -X GET "https://desk.zoho.com/api/v1/tickets/1892000000143237"
-H "orgId:2389290"
-H "Authorization: Zoho-oauthtoken 1000.abc123def456..."
Request Example
$ curl -X GET https://desk.zoho.com/api/v1/tickets/1892000000143237
-H "orgId:2389290"
-H "Authorization:Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"
Response Example
HTTP/1.1 200 Ok
Content-Type: application/json;charset=UTF-8
When making API calls, you must use the base URL corresponding to your user's data center. The correct URL is returned as api_domain in the access token response.
| Data Center | API Base URL |
|---|---|
United States (US) | https://desk.zoho.com |
India (IN) | https://desk.zoho.in |
Australia (AU) | https://desk.zoho.com.au |
Canada (CA) | https://desk.zohocloud.ca |
Saudi Arabia (SA) | https://desk.zoho.sa |
Japan (JP) | https://desk.zoho.jp |
China (CN) | https://desk.zoho.com.cn |
European Union (EU) | https://desk.zoho.eu |
Singapore (SG) | https://desk.zoho.sg |
United Arab Emirates (UAE) | https://desk.zoho.ae |
Note:Important: Never hardcode a single region's URL. Always use the api_domain from the access token response. See Multi-DC Support
Any OAuth token generated is linked to a Zoho Desk organization. This process of associating the token with an organization, which occurs in the backend while obtaining authorization consent from the end user, is called organization binding.
If the end user has only one Zoho Desk organization (portal), the OAuth token is linked to it automatically. If they have multiple organizations, they must manually select the one to which the token should be linked, as illustrated in the following image.
After clicking the Submit button, the OAuth token is generated with the selected organization bound to it.
Zoho Desk APIs automatically extract organization information from the OAuth token. Therefore, it is not necessary to include the orgId query parameter in API calls or pass it in the request headers. However, if it is provided, ensure that the orgId value matches the portal associated with the OAuth token. If the IDs do not match, the API call fails and returns the OAUTH_ORG_MISMATCH error message.
Zoho Desk supports webhooks that asynchronously deliver information on events that occur in the help desk. These events include actions, such as creating or updating a ticket, contact, or account, and so on. For information on how to include Zoho Desk webhooks in your service, refer to this document.
Your help center is one of the key channels through which customers can seek support. This portal provides your customers with access to major help modules, such as your knowledge base, user community, live chat, and ticket submission form. A well-designed and well-maintained help center ensures good self-service capabilities for your customers and lesser burden on your support agents. To know more about this please refer this document
The Zoho Desk Java SDK helps you create client Java applications that can be integrated with your Zoho Desk portal. This SDK makes it easy to access and use Zoho Desk APIs where necessary. In other words, it serves as a wrapper for the REST APIs, making it easy to use Zoho Desk's functionalities in your custom applications. To know more about this SDK please refer this document
In Zoho Desk, each business is categorized as an organization. If you have multiple businesses, set each business up as an individual organization by creating a new signup and generating a unique organization ID. All APIs except the ones directly related to organizations must include the organization ID in the header in this format: orgId:{organization_id}
string
Actual name of the organization/business
string
Unique name for the help desk portal. Only lower-case letters and numbers are allowed in the name.
string
Phone number of the organization
string
Zoho Desk edition purchased. Values allowed are: FREE, ENTERPRISE, PROFESSIONAL, ULTIMATE, STANDARD and EXPRESS.
long
Unique ID of the organization
boolean
Key that returns if the organization is the default organization of the user
boolean
Key that returns if the user is an admin in the organization
string
URL of the help desk portal
string
URL of the image file displaying the organization's logo
string
Alternative name for the help desk portal
string
Number of employees in the organization
string
Employee count range of the organization
string
Industry of the organization
string
Time zone of the organization as an IANA zone ID such as Pacific/Niue
list
Preferred solutions selected during onboarding
string
Migration source information captured during onboarding
list
Preferred communication channels selected during onboarding
string
Designation of the primary contact
string
Brief description of the organization
string
Mobile number of the organization
string
Website of the organization
string
Fax number of the organization
string
Primary contact person in the organization
string
Street in which the organization's office is located
string
City in which the organization's office is located
string
State in which the organization's office is located
string
Zip code of the organization's address
string
Country in which the organization's office is located
string
Currency locale in which the organization operates
string
Currency symbol used in the organization
Example
This API fetches the details of an organization from your help desk.
Credit: 1 credit/call
boolean
optional,Key that denotes if the customDomain field must be included in the API response
OAuth Scope
Desk.organization.READ , Desk.basic.READ
Request Example
Response Example
This API lists all organizations to which the current user belongs.
OAuth Scope
Desk.organization.READ , Desk.basic.READ
Request Example
Response Example
This API lists all organizations which can be accessed using the current Oauth token.
OAuth Scope
Desk.organization.READ , Desk.basic.READ
Request Example
Response Example
This API updates the details of an organization.
Credit: 1 credit/call
string
optional,Actual name of the organization/business
string
optional,Unique name for the help desk portal. Only lower-case letters and numbers are allowed in the name.
string
optional,Phone number of the organization
string
optional,Zoho Desk edition purchased. Values allowed are: FREE, ENTERPRISE, PROFESSIONAL, ULTIMATE, STANDARD and EXPRESS.
string
optional,Alternative name for the help desk portal
string
optional,Number of employees in the organization
string
optional,Employee count range of the organization
string
optional,Industry of the organization
string
optional,Time zone of the organization as an IANA zone ID such as Pacific/Niue
list
optionalPreferred solutions selected during onboarding
string
optional,Migration source information captured during onboarding
list
optionalPreferred communication channels selected during onboarding
string
optional,Designation of the primary contact
string
optional,Brief description of the organization
string
optional,Mobile number of the organization
string
optional,Website of the organization
string
optional,Fax number of the organization
string
optional,Primary contact person in the organization
string
optional,Street in which the organization's office is located
string
optional,City in which the organization's office is located
string
optional,State in which the organization's office is located
string
optional,Zip code of the organization's address
string
optional,Country in which the organization's office is located
string
optional,Currency locale in which the organization operates
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API fetches the logo set for an organization/portal in your help desk.
string
optional,Key that helps avoid browser cache. Only alphanumeric values are allowed.
string
optional,Size of the image file to download. Values allowed are THUMBNAIL (image with reduced dimensions and size) and ACTUAL (image with actual dimensions and size). The default value is ACTUAL.
OAuth Scope
Request Example
Response Example
This API fetches the favicon set for an organization/portal in your help desk.
string
optional,Key that helps avoid browser cache. Only alphanumeric values are allowed.
string
optional,Size of the image file to download. Values allowed are THUMBNAIL (image with reduced dimensions and size) and ACTUAL (image with actual dimensions and size). The default value is ACTUAL.
OAuth Scope
Request Example
Response Example
This API updates the logo set for an organization/portal in your help desk.
Note: To upload organization logo generate OAuthToken for the scope: Desk.organization.UPDATE,profile.orglogo.UPDATE
Credit: 1 credit/call
Content-Type:multipart/form-data
Image file of the logo.The maximum file size allowed is 2 MB ; and extensions allowed are: .jpg,.png,.jpeg.
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API updates the favicon set for an organization/portal in your help desk.
Credit: 1 credit/call
Content-Type:multipart/form-data
Image file of the favicon.The maximum file size allowed is 2 MB ;and extensions allowed are .jpg,.png,.gif,.jpeg,.ico
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API deletes the logo set for an organization/portal in your help desk.
Credit: 1 credit/call
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API updates the favicon set for an organization/portal in your help desk.
Credit: 1 credit/call
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API updates the default organization for the current user in Zoho Desk.
Credit: 1 credit/call
long
requiredUnique ID of the organization to be marked as default org
OAuth Scope
Desk.basic.UPDATE
Request Example
Response Example
These APIs work with Licensing in Zoho Desk
This API fetches the details of the current portal’s license plan information.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
OAuth Scope
Desk.basic.READ
Request Example
Response Example
Fetches a list of all available license features in Desk along with their applicability and usage limits for the current portal.
Response Fields:
featureName (String): The display name of the feature as configured in the Zoho License Framework (ZLF).
featureCode (String): The unique feature code defined in the ZLF feature file.
isAllowed (Boolean): Indicates whether the feature is enabled for the current portal.
limits (Array of objects): Provides license limit details per applicable unit (for example, ORG, AGENT, DEPARTMENT, TEAM). Each object in the array contains the following fields:
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
String
optionalKey that provides feature details based on the specified feature codes.
Note: You can provide multiple codes separated by commas.
boolean
optionalKey that filters features based on whether they are allowed for the current portal.
The allowed values are true or false.
boolean
optionalFlag to include detailed per-unit feature limits (max, free, add-on) instead of only max values.
OAuth Scope
Desk.basic.READ
Request Example
Response Example
Business hours are the working hours of your help desk. In Zoho Desk, you can configure multiple business hours sets based on factors such as the shift times of your agents and the time zones of the regions you support. Defining business hours is important because the due time for responding to and resolving tickets is calculated based on these hours. They also play a critical role in time tracking and SLAs.
String
Name of the business hours set
String
Activation status of the business hours set. Possible values: ACTIVE, INACTIVE
String
Type of the business hours set. Possible values: 24X7, SPECIFIC, CUSTOM
deprecated
long
ID of the holiday list to associate with the business hours set. Note: Deprecated. Use holidayListIds to associate holidays with business hours
list
ID(s) of the holiday lists to associate with the business hours set. Note: A maximum of 2 holiday lists can be associated with the business hours set
string
ID of the time zone to associate with the business hours set
list
Business hours configured for the week
Example
Creates a business hours set in the help desk portal.
Credit: 1 credit/call
String
requiredName of the business hours set
String
requiredActivation status of the business hours set. Possible values: ACTIVE, INACTIVE
String
requiredType of the business hours set. Possible values: 24X7, SPECIFIC, CUSTOM
deprecatedlong
optionalID of the holiday list to associate with the business hours set. Note: Deprecated. Use holidayListIds to associate holidays with business hours
list
optionalID(s) of the holiday lists to associate with the business hours set. Note: A maximum of 2 holiday lists can be associated with the business hours set
string
optional,ID of the time zone to associate with the business hours set
list
optionalBusiness hours configured for the week
OAuth Scope
Desk.automations.CREATE
Request Example
Response Example
Retrieves the details of a business hours set configured in the help desk portal.
Credit: 1 credit/call
OAuth Scope
Desk.automations.READ
Request Example
Response Example
Updates the details of a business hours set configured in the help desk portal.
Credit: 1 credit/call
String
optionalName of the business hours set
String
optionalActivation status of the business hours set. Possible values: ACTIVE, INACTIVE
String
optionalType of the business hours set. Possible values: 24X7, SPECIFIC, CUSTOM
deprecatedlong
optionalID of the holiday list to associate with the business hours set. Note: Deprecated. Use holidayListIds to associate holidays with business hours
list
optionalID(s) of the holiday lists to associate with the business hours set. Note: A maximum of 2 holiday lists can be associated with the business hours set
string
optional,ID of the time zone to associate with the business hours set
list
optionalBusiness hours configured for the week
OAuth Scope
Desk.automations.UPDATE
Request Example
Response Example
Deletes a business hours set from the help desk portal.
Credit: 1 credit/call
OAuth Scope
Desk.automations.DELETE
Request Example
Response Example
Retrieves business hours sets, with pagination support.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
integer
optionalIndex number from which the business hours sets must be listed
integer
optional,Number of business hours sets to list
String
optionalActivation status of the business hours sets. Possible values: ACTIVE, INACTIVE
list
optionalID(s) of the business hours sets to list. Note: Up to 50 IDs can be provided by separating them with commas
OAuth Scope
Desk.automations.READ
Request Example
Response Example
Retrieves automation rules associated with the specified business hours set, with pagination support.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
integer
optionalIndex number from which the rules must be listed
integer
optional,Number of rules to list
OAuth Scope
Desk.automations.READ
Request Example
Response Example
A holiday list is the list of public holidays applicable to your help desk. In Zoho Desk, you can configure multiple holiday lists based on the regions you cater to. Holiday lists are factored in when calculating the due time for responding to and resolving tickets. They play a critical role in time tracking and SLAs. You can associate a holiday list with multiple business hours sets, but each business hours set can include only one holiday list.
String
Name of the holiday list
list
Holidays to define in the list
String
Activation status of the holiday list. Possible values: ACTIVE, INACTIVE
list
ID(s) of the business hours sets to associate with the holiday list
String
Type of the holiday list. Possible values: RECURRING, YEAR_SPECIFIC
Integer
Year the holidays fall in. Note: Required only when holidayListType is YEAR_SPECIFIC
Example
Creates a holiday list in the help desk portal.
Credit: 1 credit/call
String
requiredName of the holiday list
list
requiredHolidays to define in the list
String
requiredActivation status of the holiday list. Possible values: ACTIVE, INACTIVE
list
optionalID(s) of the business hours sets to associate with the holiday list
String
optionalType of the holiday list. Possible values: RECURRING, YEAR_SPECIFIC
Integer
optional,Year the holidays fall in. Note: Required only when holidayListType is YEAR_SPECIFIC
OAuth Scope
Desk.automations.CREATE
Request Example
Response Example
Retrieves the details of a holiday list configured in the help desk portal.
Credit: 1 credit/call
OAuth Scope
Desk.automations.READ
Request Example
Response Example
Updates the details of a holiday list configured in the help desk portal.
Credit: 1 credit/call
String
optionalName of the holiday list
list
optionalHolidays to define in the list
String
optionalActivation status of the holiday list. Possible values: ACTIVE, INACTIVE
list
optionalID(s) of the business hours sets to associate with the holiday list
OAuth Scope
Desk.automations.UPDATE
Request Example
Response Example
Deletes a holiday list from the help desk portal.
Credit: 1 credit/call
OAuth Scope
Desk.automations.DELETE
Request Example
Response Example
Retrieves holiday lists, with pagination support.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
integer
optionalIndex number from which the holiday lists must be listed
integer
optional,Number of holiday lists to list
String
optionalActivation status used to filter holiday lists. Possible values: ACTIVE, INACTIVE
OAuth Scope
Desk.automations.READ
Request Example
Response Example
Departments refer to the organizational divisions configured in your help desk, based on the business function performed by each division; for example, marketing, sales, finance, admin, and so on.
long
ID of the department
string
Name of the department
string
Display name of the department in the help center
string
A short description of the department
boolean
Key that denotes if the department is visible in the help center or not
boolean
Key that denotes if the department is enabled or not
boolean
Key that denotes if the assign to team functionality is enabled or not
boolean
Key that denotes if the department has a logo or not
long
ID of user who created the department
timestamp
Time of creating the department
list
IDs of agents associated with the department
boolean
Key that denotes if the department is the default department in the help desk portal
string
Chat status of the departments: AVAILABLE, DISABLED, NOT_CREATED
Example
This API fetches the details of a department from your help desk
Credit: 1 credit/call
OAuth Scope
Desk.departments.READ , Desk.basic.READ
Request Example
Response Example
This API lists a particular number of departments, based on the limit specified.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
boolean
optionalKey that filters departments based on their enabled status
integer
optional,Index number, starting from which the departments must be fetched
string
optional,String to search for departments by name, help center name, or description. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for departments whose name, help center name, or description start with the string, 2) *string* - Searches for departments whose name, help center name, or description contain the string, 3) string - Searches for departments whose name, help center name, or description is an exact match for the string
integer
optional,Number of departments to fetch; default value is 10 and maximum value supported is 200
string
optional,Key that filters departments based on their chat status. Values allowed are AVAILABLE, DISABLED, NOT_CREATED, and ${UNAVAILABLE}. ${UNAVAILABLE} refers to departments which are not available for chat.
OAuth Scope
Desk.departments.READ , Desk.basic.READ
Request Example
Response Example
This API lists departments, that is assocaited with user
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
boolean
optionalKey that filters departments based on their enabled status
string
optional,Key that filters departments based on their chat status. Values allowed are AVAILABLE, DISABLED, NOT_CREATED, and ${UNAVAILABLE}. ${UNAVAILABLE} refers to departments which are not available for chat.
OAuth Scope
Desk.departments.READ , Desk.basic.READ
Request Example
Response Example
This API lists the agents in a department.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
integer
optionalIndex number, starting from which the agents must be listed
integer
optional,Number of agents to fetch; default value is 10 and maximum value is 200
string
optional,Key that filters agents, based on their activation status: ACTIVE or DISABLED
boolean
optionalKey that denotes if the agents must be light or non light.
boolean
optionalKey that denotes if the agents must be confirmed or unconfirmed.
string
optional,String to search for agents by first name, last name, or email ID. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for agents whose first name, last name, or email ID start with the string, 2) *string* - Searches for agents whose first name, last name, or email ID contain the string, 3) string - Searches for agents whose first name, last name, or email ID is an exact match for the string
string
optional,Name of the field that must be used for searching and listing agents. Values allowed are: firstName, lastName, name, and emailId.
string
optional,To sort the available list of agents in either ascending or descending order. Values allowed are: asc or desc
OAuth Scope
Desk.basic.READ , Desk.agents.READ
Request Example
Response Example
This API returns the number of departments configured in your help desk portal.
Credit: 50 credits/call
boolean
optionalKey that filters departments based on their enabled status
OAuth Scope
Desk.departments.READ , Desk.basic.READ
Request Example
Response Example
This API fetches the details of the departments whose IDs are passed in the API request.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
long
requiredComma-separated array of department IDs. Maximum number of IDs allowed is 50.
OAuth Scope
Desk.departments.READ , Desk.basic.READ
Request Example
Response Example
This API lists the associable agents in a department in your helpdesk.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
integer
optional,Index number, starting from which the agents must be listed
integer
optional,Number of agents to fetch; default value is 10 and maximum value is 100
string
optional,Key that filters agents based on their activation status: ACTIVE or DISABLED
string
optional,String to search for agents by first name, last name, or email ID. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for agents whose first name, last name, or email ID start with the string, 2) *string* - Searches for agents whose first name, last name, or email ID contain the string, 3) string - Searches for agents whose first name, last name, or email ID is an exact match for the string
string
optional,Name of the field that must be used for searching and listing agents. Values allowed are: firstName, lastName, name, and emailId.
string
optional,To sort the available list of agents in either ascending or descending order. Values allowed are: asc or desc
OAuth Scope
Desk.departments.READ , Desk.basic.READ
Request Example
Response Example
This API checks if multiple departments have the same name.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
string
required,Name of the department for which you want to check duplicate entries
OAuth Scope
Desk.departments.READ
Request Example
Response Example
This API adds a department to your help desk portal.
Credit: 1 credit/record
string
required,Name of the department
string
optional,Display name of the department in the help center
string
optional,A short description of the department
boolean
optionalKey that denotes if the department is visible in the help center or not
boolean
optionalKey that denotes if the assign to team functionality is enabled or not
list
requiredIDs of agents associated with the department
OAuth Scope
Desk.departments.CREATE
Request Example
Response Example
This API updates the details of an existing department.
Credit: 1 credit/call
string
optional,Name of the department
string
optional,Display name of the department in the help center
string
optional,A short description of the department
boolean
optionalKey that denotes if the department is visible in the help center or not
boolean
optionalKey that denotes if the assign to team functionality is enabled or not
list
optionalIDs of agents associated with the department
OAuth Scope
Desk.departments.UPDATE
Request Example
Response Example
This API disables a department in your help desk portal.
Credit: 1 credit/call
Long
optionalAgents move to new department ID
Long
optionalEmail move to new department ID
OAuth Scope
Desk.departments.UPDATE
Request Example
Response Example
This API enables a department in your help desk portal.
Credit: 1 credit/call
OAuth Scope
Desk.departments.UPDATE
Request Example
Response Example
This API associates agents to a department.
Credit: 1 credit/call
list
requiredIds of Agents
OAuth Scope
Desk.permissions.UPDATE
Request Example
Response Example
This API dissociates agents from a department.
Credit: 1 credit/call
list
requiredIds of Agents
OAuth Scope
Desk.permissions.UPDATE
Request Example
Response Example
This API fetches the logo set for a department.
Credit: 1 credit/call
string
optional,Size of the image file to download. Values allowed are THUMBNAIL (image with reduced dimensions and size) and ACTUAL (image with actual dimensions and size). The default value is ACTUAL.
OAuth Scope
Desk.departments.READ , Desk.basic.READ
Request Example
Response Example
This API updates the logo set for a department.
Credit: 1 credit/call
Content-Type:multipart/form-data
Image file of the logo. Maximum file size allowed is 2MB; maximum number of files allowed is one; and extensions allowed are: jpg, png, gif, and jpeg.
OAuth Scope
Desk.departments.UPDATE
Request Example
Response Example
This API removes the logo set for a department.
Credit: 1 credit/call
OAuth Scope
Desk.departments.UPDATE
Request Example
Response Example
By default, the web address of your help center is a Zoho Desk sub-domain in the "desk.zoho.com/portal/<mycompany>" format. However, you can personalize this address, so that your customers can submit their tickets from a sub-domain, such as 'support.mycompany.com'. This feature is called domain/host mapping.
string
Address of the domain
boolean
Key that denotes if the domain is verified
boolean
Key that denotes if the domain is applied to the portal
string
Zoho Desk domain security code to add in the domain service provider's CNAME
timestamp
Time of verifying the domain
timestamp
Time of applying the domain to the portal
long
ID of user who verified the domain
long
ID of user who applied the domain to the portal
string
SSL status of the domain
string
SSL request status of the domain if SSL certificate is requested for the domain
long
ID of user who requested for the SSL certificate for the domain
timestamp
Time of requesting the SSL certificate for the domain
Example
This API adds a domain to your help desk.
Credit: 1 credit/call
string
required,Address of the domain
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API verifies a domain in your help desk.
Credit: 1 credit/call
string
required,Domain to be verified.
string
required,Domain verification method. CNAME or HTML.
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API maps a domain to the default portal in your help desk.
Credit: 1 credit/call
string
required,Address of the domain
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API resets the current domain of the default portal in your help desk.
Credit: 1 credit/call
OAuth Scope
Desk.organization.UPDATE
Request Example
Response Example
This API lists the domains configured in your help desk.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
boolean
optionalKey that filters domains based on their verification status
boolean
optionalKey that filters domains based on their application status in the help desk
OAuth Scope
Desk.organization.READ
Request Example
Response Example
Products are the goods/services your organization sells.
long
ID of the product
long
ID of user to whom the product is assigned
string
Name of the product
string
Reference code of the product
string
Category to which the product belongs
string
Organization that manufactures the product
double
Price of the product
deprecated
list
User-defined fields related to the product
list
User-defined fields related to the product
long
User who added the product to the help desk portal
long
User who modified the details of the product
timestamp
Time of adding the product to the help desk portal
timestamp
Time of modifying product details
string
Description of the product
Example
This API fetches a single product from your helpdesk.
Credit: 1 credit/call
string
optional,Key that fetches secondary information related to the product. Values allowed are: departments and owner. You can pass multiple values by separating them with commas.
OAuth Scope
Desk.products.READ
Request Example
Response Example
This API lists a specific number of products from your help desk portal, based on the limit defined. (Note: The departmentIds key will soon be deprecated and not included in API responses.)
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
long
optionalID of the view to apply while fetching the products
integer
optionalIndex number, starting from which the products must be fetched
integer
optional,No. of products to fetch
long
optionalID of the department from which the products must be fetched. If you want to list the products configured in all accessible departments, pass the value 0.
long
optionalID of user to whom the product is assigned
string
optional,Sort by a specific attribute : productName, productCode, unitPrice, createdTime or modifiedTime. The default sorting order is ascending. A - prefix denotes descending order of sorting.
string
optional,Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: layoutId. Maximum of 30 fields is supported as comma separated values.
list
optionalSecondary information related to the contact.Value supported is owner.
OAuth Scope
Desk.products.READ
Request Example
Response Example
This API adds a product to your helpdesk.
Credit: 1 credit/call
long
optionalID of user to whom the product is assigned
string
required,Name of the product
string
optional,Reference code of the product
string
optional,Category to which the product belongs
string
optional,Organization that manufactures the product
double
optionalPrice of the product
deprecatedlist
optionalUser-defined fields related to the product
list
optionalUser-defined fields related to the product
string
optional,Description of the product
OAuth Scope
Desk.products.CREATE
Request Example
Response Example
This API lists tickets received from a specific products.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
long
optionalID of the department from which the tickets must be fetched
Integer
optionalIndex number, starting from which the tickets must be fetched
Integer
optional,Number of tickets to fetch
string
optional,Sort by a specific attribute: createdTime or modifiedTime. The default sorting order is ascending. A - prefix denotes descending order of sorting.
string
optional,Filter by ticket duedate. Values allowed are overdue, tomorrow, currentWeek, currentMonth and today. You can include both values by separating them with a comma
boolean
optional,Filters Spam tickets
string
optional,Additional information related to the tickets. Values allowed are: products, departments, team, isRead and assignee. You can pass multiple values by separating them with a comma in the API request.
OAuth Scope
Desk.tickets.READ
Request Example
Response Example
This API updates details of a product in your help desk portal.
Credit: 1 credit/call
long
optionalID of user to whom the product is assigned
string
optional,Name of the product
string
optional,Reference code of the product
string
optional,Category to which the product belongs
string
optional,Organization that manufactures the product
double
optionalPrice of the product
deprecatedlist
optionalUser-defined fields related to the product
list
optionalUser-defined fields related to the product
string
optional,Description of the product
OAuth Scope
Desk.products.UPDATE
Request Example
Response Example
This API moves products to the Recycle Bin of your help desk portal.
Credit: 6 credits/record
list
requiredIDs of the products you want to delete
OAuth Scope
Desk.products.DELETE
Request Example
Response Example
This API searches for duplicate records of a product.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
integer
optionalIndex number, starting from which the products must be fetched
integer
optional,No. of products to fetch
string
required,Name of the product, used as the keyword for the search
OAuth Scope
Desk.products.READ
Request Example
Response Example
This API associates contacts with a product. Only a maximum of 10 contacts can be associated with a product through a single API request.
Credit: 1 credit/call
list
requiredIDs of the resources to associate
boolean
requiredtrue for associating the resource and false for dissociating the resource
OAuth Scope
Desk.products.UPDATE
Request Example
Response Example
This API associates accounts with a product. Only a maximum of 10 accounts can be associated with a product through a single API request.
Credit: 1 credit/call
list
requiredIDs of the resources to associate
boolean
requiredtrue for associating the resource and false for dissociating the resource
OAuth Scope
Desk.products.UPDATE
Request Example
Response Example
This API lists the accounts associated with a product
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
int
optionalIndex number starting from which the accounts must be fetched
integer
optional,Number of accounts to fetch
string
optional,Key that sorts the accounts by a specific attribute: accountName or createdTime.The default sorting order is ascending. A - prefix denotes descending order of sorting
OAuth Scope
Desk.accounts.READ
Request Example
Response Example
This API lists the contacts associated with a product.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
int
optionalIndex number, starting from which the contacts must be listed
integer
optional,Number of contacts to fetch
string
optional,Parameter that sorts contacts by one of these attributes: firstName, lastName, phone, email, account, createdTime, modifiedTime
list
optionalKey that fetches secondary information related to the contact.Value allowed is accounts
boolean
optional,Filters Spam contacts
OAuth Scope
Desk.contacts.READ
Request Example
Response Example
Product attachments are the files you attach to a product to aid quick resolution.
long
ID of the attachment Note : This ID can be used only by the user who uploaded the attachment. If another user tries to use the attachment ID in other APIs such as sendEmailReply, draftEmailReply, etc an error will be thrown.
long
ID of user who attached the file
timestamp
Time of attaching the file
string
Name of the attachment
boolean
Key that returns if the attachment is public or not
long
Size of the attachment
Example
This API lists all attachments in a product.
Credit: 3 credits/call
Note: Credits depends on the range where the records are fetched. Refer for details
string
optional,Sort by the createdTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting.
integer
optionalfrom Index
integer
optional,the number of attachments to be displayed
string
optional,Secondary information related to the attachments. Value allowed is creator, which returns the details of users who added the attachments.
OAuth Scope
Desk.products.READ
Request Example
Response Example
This API attaches a file to a product.
Credit: 1 credit/call
Content-Type:multipart/form-data
attachment to be added
OAuth Scope
Desk.products.UPDATE
Request Example
Response Example
This API deletes an attachment from a product.
Credit: 1 credit/call
OAuth Scope
Desk.products.UPDATE
Request Example
Response Example
These public APIs help access details of the countries,languages and time zones supported in Zoho Desk.
Example
This API lists the countries that can be set in the locale field in Zoho Desk. Keep in mind that the countries object will be deprecated soon. Therefore, make sure to use the data object instead, wherever needed.
OAuth Scope
Request Example
Response Example
This API lists the languages that are available for listing in Zoho Desk.
OAuth Scope
Request Example
Response Example
This API lists the time zones that are available for listing in Zoho Desk.
OAuth Scope
Request Example
Response Example
Allowed iframe domains specify the domains that are permitted to embed the help desk portal in an iframe.
Example