Skip to main content
Zoho Desk logo
  • Category: crm
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 36
  • Triggers: 0
  • Slug: ZOHO_DESK
  • Version: 20261103_00

Tools

Slug: ZOHO_DESK_CREATE_CONTACTTool to create a new contact in Zoho Desk with name, email, and other details. Use this action when you need to add a new contact to the system, such as when onboarding a new customer or registering a support requester. Returns the created contact with id and webUrl for downstream operations.

Input Parameters

string
Zip or postal code
string
City
string
Type or category of the contact
string
Primary email address of the contact
string
Optional organization ID header; overrides the default org from auth
string
Phone number
string
State or province
string
Job title or position of the contact
string
Mobile number
string
Street address
string
Country
string
ID of the user who will own this contact
string
Preferred language for communication
string
required
Last name of the contact (required)
string
ID of the account to associate this contact with
string
required
First name of the contact (required)
string
Description or notes about the contact
string
Secondary email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_CREATE_TICKETTool to create a new Zoho Desk ticket with subject, description, department, and requester details. Use when you need to create a support ticket in Zoho Desk. Returns the created ticket with id and webUrl for downstream chaining.

Input Parameters

string
Email address of the requester. Use this if you don’t have a contactId. Zoho Desk will look up or create a contact with this email. Mutually exclusive with ‘contactId’.
string
Optional organization ID header; overrides the default org from auth.
string
Phone number associated with the ticket
string
Status of the ticket
string
Channel through which the ticket was created
object
Contact information for creating a new contact with the ticket.
string
Due date for the ticket in ISO 8601 format
string
required
Subject/title of the ticket
string
Category of the ticket
string
Priority level of the ticket
string
ID of an existing contact who is submitting the ticket. Use this if you already know the contact ID. Mutually exclusive with ‘email’ and ‘contact’.
string
ID of the product related to the ticket
string
ID of the agent to assign the ticket to
string
Detailed description of the issue or request
string
Sub-category of the ticket
string
required
ID of the department to which the ticket should be assigned
string
Classification of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_DOWNLOAD_TICKET_ATTACHMENTDownload a file attachment from a Zoho Desk ticket by attachment ID. Use this action when you need to retrieve a specific file that was previously attached to a ticket. Requires both the ticket ID and the attachment ID to identify the file to download.

Input Parameters

string
Organization ID header. If omitted, the bound org from connection may be used.
string
Optional filename to use for the downloaded attachment. If not provided, a default name like ‘ticket_{ticket_id}attachment{attachment_id}’ will be used.
string
required
The ID of the ticket containing the attachment.
string
required
The ID of the attachment to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_ACCOUNTRetrieve one Zoho Desk customer account by its account ID.

Input Parameters

string
Optional Zoho Desk organization ID sent in the orgId header
string
required
Numeric ID of the account to retrieve
boolean
Whether to include the account owner’s details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_AGENTTool to fetch details of a Zoho Desk agent. Use when you have an agent ID and need its full data, optionally including related resources.

Input Parameters

string
Optional organization ID header; must match the OAuth token’s org.
array
List of related resources to include: ‘profile’, ‘role’, ‘associatedDepartments’, ‘associatedChatDepartments’, ‘verifiedEmails’.
string
required
The Zoho Desk agent ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_AGENTS_COUNTTool to get the total count of agents in Zoho Desk. Use when you need the number of agents optionally filtered by status, confirmation, or light agents.

Input Parameters

string
Zoho Desk organization ID header. If provided, will be added as ‘orgId’ header.
string ("ACTIVE" | "DISABLED")
Filter by agent activation status (ACTIVE or DISABLED).
boolean
Filter by confirmation status (true: confirmed agents only).
boolean
Whether to include light agents in the count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_CONTACTTool to fetch details of a Zoho Desk contact. Use when you have a contact ID and need its full data, optionally including accounts or owner details.

Input Parameters

string
Optional organization ID header; must match the OAuth token’s org.
array
List of related resources to include: ‘accounts’, ‘owner’.
string
required
The Zoho Desk contact ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_CONTACTS_BY_IDSTool to fetch multiple contacts by their IDs using Zoho Desk’s contactsByIds endpoint.

Input Parameters

array
required
List of up to 20 contact IDs to retrieve (max 20).
string
Optional Zoho Desk organization ID header; if provided, must match the OAuth token’s organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_DEPARTMENTTool to fetch details of a Zoho Desk department by ID.

Input Parameters

string
Optional organization ID header; if provided, must match the OAuth token’s organization.
string
required
The Zoho Desk department ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_DEPARTMENT_LOGOTool to get/download a department’s logo from Zoho Desk.

Input Parameters

string
Organization ID header. If omitted, the bound org from connection may be used.
string
Optional filename to use for the downloaded logo. If not provided, a default name like ‘department_<id>_logo’ will be used.
string
required
The Zoho Desk Department ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_DEPARTMENTS_COUNTTool to get the total count of departments in Zoho Desk. Use when you need the number of departments, optionally filtered by enabled status.

Input Parameters

string
Zoho Desk organization ID header. If provided, will be added as ‘orgId’ header.
boolean
Filter by department enabled status (true: enabled departments only).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_TICKETGet Ticket

Input Parameters

string
Optional Zoho Desk organization ID; if provided, overrides default.
string
Comma-separated list of related entities to embed. Allowed values: contacts, products, assignee, departments, contract, isRead, team, skills
string
required
The Zoho Desk ticket ID to fetch. Pass it as a string to preserve all digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_TICKET_LATEST_THREADTool to fetch the most recent thread of a ticket. Use when you need the latest conversation on a ticket.

Input Parameters

string
Optional Zoho organization ID; if provided, overrides default.
string
Set to ‘plainText’ to return content in plain text.
string
required
The Zoho Desk ticket ID to fetch the latest thread for. Pass it as a string to preserve all digits.
boolean
Whether to return only public threads.
string ("success" | "failed")
Filter threads by status; allowed values: ‘success’, ‘failed’.
boolean
Whether to return only incoming threads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_TICKET_RESOLUTIONGet Ticket Resolution

Input Parameters

string
Optional Zoho Desk organization ID; if provided, will be sent as orgId header.
string
required
The Zoho Desk ticket ID whose resolution is to be fetched. Pass it as a string to preserve all digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_GET_TICKET_THREADTool to fetch a specific thread within a Zoho Desk ticket. Use when you need detailed thread information by ticket and thread IDs.

Input Parameters

string
Optional Zoho Desk organization ID; if provided, overrides default.
string
Set to ‘plainText’ to return the thread content in plain text.
string
required
The ID of the thread to retrieve. Pass it as a string to preserve all digits.
string
required
The Zoho Desk ticket ID to fetch the thread from. Pass it as a string to preserve all digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_AGENTSTool to list all agents in the Zoho Desk organization with optional filtering and pagination. Use when you need to retrieve multiple agents, optionally filtered by status or confirmation state.

Input Parameters

integer
Number of agents to return per request (1-50; default: 25)
string
Optional Zoho Desk organization ID header; if provided, must match the OAuth token’s organization
string ("ACTIVE" | "DISABLED")
Filter by agent activation status (ACTIVE or DISABLED)
array
List of related resources to include: ‘profile’, ‘role’
integer
Starting index for pagination (default: 0)
boolean
Filter by confirmation status (true: confirmed agents only)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_CONTACT_ACCOUNTSLists accounts associated with a Zoho Desk contact. If license access to the account listing is limited, a fallback may return at most one account or an empty list, rather than the full set of associated accounts.

Input Parameters

integer
Maximum number of accounts to return (1–100).
string
Organization ID header; must match the OAuth token’s org.
string
Sort by fields: ‘accountName’, ‘createdTime’, or ‘mappingType’; prefix with ’-’ for descending
string
required
ID of the contact whose accounts to list.
integer
Zero- or one-based index to start listing from. Mapped to query parameter ‘from’.
string
Filter by the starting letter(s) of account names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_CONTACTSTool to list contacts with filters and pagination. Use when you need to fetch contacts from Zoho Desk with optional filtering, sorting, or field selection.

Input Parameters

integer
Number of contacts to fetch (1–100; default: 10)
string
Comma-separated list of up to 30 fields to return
string
Sort by fields: ‘firstName’, ‘lastName’, or ‘createdTime’; prefix with ’-’ for descending
string
ID of the view to apply while fetching contacts. Pass it as a string to preserve all digits.
array
Secondary information to include; allowed value: ‘accounts’
integer
Offset index to start fetching from (default: 1). Mapped to ‘from’ query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_CONTACT_TICKETSList one offset-limited page of tickets raised by a Zoho Desk contact. Use from_index and limit to select the page.

Input Parameters

integer
Maximum number of tickets to return (1-100)
string
Optional Zoho Desk organization ID sent in the orgId header
boolean
Filter tickets by spam status
string ("createdTime" | "-createdTime" | "modifiedTime" | "-modifiedTime")
Sort by created or modified time; prefix the value with - for descending order
string
required
Numeric ID of the contact whose tickets are requested
integer
Zero-based offset sent as the from query parameter
string
Numeric department ID used to restrict returned tickets

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_DEPARTMENTSList departments in the current Zoho Desk organization. Returns the API’s default page of up to 10 departments.

Input Parameters

string
Optional Zoho Desk organization ID header; if provided, must match the OAuth token’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_ORGANIZATIONSTool to list all organizations the current user belongs to. Use when you need to retrieve organization metadata like portal URLs, names, and editions.

Input Parameters

string
Optional Zoho Desk organization ID header; if provided, must match the OAuth token’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_ROLESList Roles

Input Parameters

integer
Start index for pagination (>=0)
integer
Number of roles to return (0–500)
string
Optional Zoho Desk organization ID header; must match OAuth token’s org
boolean
Filter default vs custom roles
boolean
Filter by UI visibility
string
Search by name/description; supports string*, string, exact; max 100 chars

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_ROLES_BY_IDSList Roles By IDs

Input Parameters

string
Optional Zoho Desk organization ID header; must match OAuth token’s org
array
required
List of role IDs to retrieve (comma-joined in query; max 50)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_TEAMS_IN_DEPARTMENTTool to list teams in the specified Zoho Desk department.

Input Parameters

string
Optional Zoho Desk organization ID header; if provided, must match the OAuth token’s organization
string
required
ID of the department whose teams to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_TICKET_COMMENTSList comments recorded on a Zoho Desk ticket. Returns one offset-limited page; from_index and limit control the page.

Input Parameters

integer
Maximum number of comments to return (1-100)
string
Optional Zoho Desk organization ID sent in the orgId header
array
Related comment representations to include: mentions, plainText, or both
string ("commentedTime" | "-commentedTime")
Sort by comment time: commentedTime for ascending or -commentedTime for descending; omission uses the provider default
string
required
Numeric ID of the ticket whose comments are requested
integer
Zero-based offset sent as the from query parameter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_TICKET_CONVERSATIONSList Ticket Conversations

Input Parameters

integer
Starting index from which conversations are fetched; range: >= 0
integer
Number of conversations to fetch; range: 1–200; default decided by API
string
Zoho Desk organization ID to be passed in orgId header
string
required
ID of the ticket whose conversations are to be listed. Pass it as a string to preserve all digits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_TICKET_HISTORYList audit and activity history for a ticket. History records describe ticket changes and actions. Use the conversation or thread actions instead when you need message and comment content.

Input Parameters

integer
Maximum number of history events to return (1-50)
string
Optional Zoho Desk organization ID sent in the orgId header
string
Numeric agent ID used to filter history events
string
required
Numeric ID of the ticket whose history is requested
string
Ticket field name used to filter history events
integer
Zero-based offset sent as the from query parameter
string
Provider-defined history category sent as eventFilter, such as CommentHistory, AttachmentHistory, WorkflowHistory, or ZiaRelatedHistory

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_TICKETSList Tickets

Input Parameters

integer
Offset index to start fetching from (default: 1)
integer
Number of tickets to fetch (1–100; default: 10)
string
Organization ID header
string
View ID to filter tickets

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_TICKET_THREADSList message threads recorded on a Zoho Desk ticket. This returns threads only. Use the conversations action when comments and threads should be returned together.

Input Parameters

integer
Maximum number of threads to return (1-200)
string
Optional Zoho Desk organization ID sent in the orgId header
string ("sendDateTime" | "-sendDateTime")
Sort by send time: sendDateTime for ascending or -sendDateTime for descending; omission uses the provider default
string
required
Numeric ID of the ticket whose threads are requested
integer
Zero-based offset sent as the from query parameter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_LIST_VIEWSList all ticket views in the Zoho Desk organization with pagination support. Views are saved filters that help organize and display tickets based on specific criteria. Use this action when you need to retrieve available views for filtering tickets, such as before calling the list tickets endpoint with a specific viewId.

Input Parameters

integer
Offset index to start fetching from (default: 1)
integer
Number of views to fetch per page (1-100; default: 25)
string
Optional Zoho Desk organization ID header; if provided, must match the OAuth token’s organization
string
required
The module to list views for. Common values: ‘tickets’, ‘contacts’, ‘accounts’, ‘tasks’, ‘calls’, ‘events’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_SEARCHSearch Zoho Desk tickets, accounts, contacts, and tasks by keyword or phrase, across all modules or within a selected module. Filter by department, sort by relevance or modified time, and paginate matching results.

Input Parameters

integer
Pagination offset to start fetching results from (default: 1)
integer
Number of results to return (default: 25, maximum: 50)
string
Optional organization ID header; overrides the default org from auth
string ("tickets" | "accounts" | "contacts" | "tasks")
Enum for searchable modules in Zoho Desk.
string ("relevance" | "modifiedTime")
Enum for sort options in search results.
string
Keyword or phrase to search for across modules
string
Filter results by department ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_UPDATE_ACCOUNTTool to update an existing Zoho Desk account’s information such as name, email, phone, website, or description. Use this action when you need to modify account details after the account has been created. Only the fields you provide will be updated; other fields remain unchanged.

Input Parameters

string
Email address associated with the account.
string
Optional organization ID header; must match the OAuth token’s org.
string
Phone number of the account.
string
Website URL of the account.
string
required
The Zoho Desk account ID to update.
string
Name of the account or company.
string
Description or notes about the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_UPDATE_MANY_TASKSUpdate one field across multiple Zoho Desk tasks in a single call, for up to 50 task IDs. Results report success or errors for each task.

Input Parameters

array
required
Array of task IDs to update as strings to preserve all digits (max 50)
string
(header) Organization ID of the Zoho Desk account
string
required
Name of the field to update
string
Value to set for the field
boolean
Whether the field is a custom field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_UPDATE_TICKETUpdates an existing Zoho Desk ticket by modifying provided fields such as status, priority, assignee, or description. Returns the updated ticket’s supported fields.

Input Parameters

string
Optional organization ID header; overrides the default org from auth
string
Updated phone number associated with the ticket
string
Updated status of the ticket
string
Updated channel through which the ticket was created
string
Updated due date for the ticket in ISO 8601 format
string
Updated subject/title of the ticket
string
Updated category of the ticket
string
Updated priority level of the ticket
string
ID of the contact associated with the ticket
string
ID of the product related to the ticket
string
required
The ID of the ticket to update
string
ID of the agent to assign or reassign the ticket to
string
Updated detailed description of the issue or request
string
Updated sub-category of the ticket
string
ID of the department to which the ticket should be assigned
string
Updated classification of the ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_UPLOAD_DEPARTMENT_LOGOTool to upload/update a department logo in Zoho Desk.

Input Parameters

string
Organization ID header. If omitted, the bound org from connection may be used.
string
required
The Zoho Desk Department ID.
File to upload as department logo (jpg, jpeg, png, gif; max 2 MB). This will be sent as multipart form field named ‘departmentLogo’.
string
MIME type for the uploaded file (e.g., image/png, image/jpeg, image/gif). Defaults to image/png if not specified.
string
Filename to use when uploading (used if Base64 content is provided).
string
Base64-encoded image content to upload as the department logo. If provided, it will be decoded and sent as ‘departmentLogo’ multipart field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DESK_UPLOAD_TICKET_ATTACHMENTUploads a file attachment to a specific Zoho Desk ticket. The uploaded file becomes accessible as an attachment within the ticket for support agents and customers to reference. Use this action when you need to attach documentation, screenshots, logs, or any supporting files to an existing ticket. Maximum file size is 20 MB per attachment.

Input Parameters

object
required
File to upload as ticket attachment. Provide an uploaded file or file URL. Maximum file size is 20 MB.
string
Organization ID header. If omitted, the bound org from connection may be used.
string
required
The ID of the ticket to upload the attachment to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not