Skip to content
Changelog

Report a bug

Zoho Desk integration: operations for AI agents

Zoho Desk connects to Type.com as an integration. This page lists the 906 operations documented for Claude and Codex in Type.com: 452 read, 335 write, 119 destructive.

About Zoho Desk

Zoho Desk is a context-aware helpdesk platform enabling support teams to track tickets, automate workflows, and gain insights on customer interactions

Categories: Sales & CRM

How to connect Zoho Desk to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

906 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

906 operations listed.

Account Attachment

  • Read

    Get Account Attachments

    Retrieves attachments for the specified account, with pagination support.

  • Write

    Create Account attachment

    This API attaches a file to an account.

  • Destructive

    Delete Account Attachment

    Deletes an attachment from the specified account.

Account Comments

  • Read

    Get an account comment

    This API fetches an account comment from the portal.

  • Read

    List all account comments

    This API lists a particular number of comments recorded on an account, based on the limit specified.

  • Write

    Create an account comment

    This API adds a comment to an account.

  • Destructive

    Update an account comment

    This API updates an existing account comment.

  • Destructive

    Delete an account comment

    This API deletes an existing account comment.

Account Contact Mapping Info

  • Write

    Update association info

    This API updates the details of an account-contact mapping.

Account Deduplication

  • Read

    Get Default Field Name

    This API fetches the name of the field set as the default field for account deduplication.

  • Read

    List duplicate accounts

    This API lists the duplicate entries of an account.The fieldName parameters is mandatory in the API request Note: If you encounter a 202 status code while executing this API request, it means there are 100,000 or more accounts in the help desk portal.

  • Read

    List details of duplicate accounts

    This API lists all the details of duplicate accounts.The fieldName and fieldValues parameters are mandatory in the API request

  • Write

    Set default field for account deduplication

    This API sets the field you specify as the default field for deduplicating accounts.

Account Followers

  • Read

    Get account followers

    This API fetches the list of users following an account.

  • Write

    Add account followers

    This API adds one or more users to the followers list of an account

  • Destructive

    Remove account followers

    This API removes one or more users from the followers list of an account

Account

  • Read

    List accounts of contact

    This API lists the accounts associated with a particular contact.

  • Read

    Get account statistics

    This API fetches the overall statistics of an account.

  • Read

    List tickets by account

    This API lists tickets received from a specific account.

  • Read

    List accounts

    This API lists a particular number of accounts, based on the limit specified.

  • Read

    Get Contracts

    Retrieves contracts for the specified account, with pagination support.

  • Read

    Get Account

    This API fetches an account from your help desk portal.

  • Read

    Get account history

    This API fetches the ticket history of an account.

  • Read

    List all accounts count

    Get accounts count

  • Read

    List accounts associated with product

    This API lists the accounts associated with a product

  • Write

    Associate products with an account

    This API associates products with an account. Only a maximum of 10 products can be associated with an account through a single API request.

  • Write

    Merge Accounts

    This API merges two or more accounts.

  • Write

    Create Account

    This API creates an account in your help desk portal.

  • Write

    Update Account

    This API updates details of an existing account.

  • Write

    Update many accounts

    This API updates multiple accounts at once.

  • Destructive

    Delete Accounts

    This API moves the accounts specified to the Recycle Bin.

Account Sla

  • Read

    List account SLAs

    This API lists a particular number of SLAs associated with an account, based on the limit defined.

  • Write

    Associate or dissociate SLA from account

    This API associates or dissociates an SLA from an account.

Account Time Entry

  • Read

    List Account Time Entries

    Retrieves time entries recorded for a ticket or task related to the specified account, with pagination support

  • Read

    Get summation of Account Time Entries

    Retrieves the summation of time entries for the specified account

Activity

  • Read

    List ticket activities

    This API lists a particular number of activities associated with a ticket, based on the limit specified.

  • Destructive

    Delete spam activities

    This API deletes all spam activities.

Actors API

  • Read

    Get Actors

    Retrieves details of actors by actor IDs.

  • Read

    Get Actor

    Retrieves details of an actor by actor ID.

Agent

  • Read

    Get My Preferences

    Retrieves the preferences of the currently logged-in agent.

  • Read

    Get Agents by Agent IDs

    Retrieves details of agents for the specified agent IDs.

  • Read

    Get Agent Photo

    Retrieves the profile photo for the specified agent. Note : To get the agent photo, generate an OAuth token for the scope Desk.agents.READ,profile.userphoto.READ or Desk.basic.READ,profile.userphoto.READ.

  • Read

    Get Agents

    Retrieves a particular number of agents based on the specified limit, with pagination support.

  • Read

    Get My Information

    Retrieves details of the currently logged-in agent.

  • Read

    Get Agent

    Retrieves details of a specific agent.

  • Read

    Get Agent Types Counts

    Retrieves counts for all agent types.

  • Read

    Get Agents Count

    Retrieves the count of agents filtered by status, confirmation state, and light-agent inclusion.

  • Read

    Get Agent by ZUID

    Retrieves the details of the agent to whom the ZUID belongs.

  • Read

    Get Agent by Email ID

    Retrieves details of an agent for the specified email ID.

  • Read

    Get Deleted Agents

    Retrieves deleted agents based on the specified limit, with pagination support.

  • Read

    Get My Entity Preferences

    Retrieves entity preferences of the currently logged-in agent.

  • Write

    Update My Preferences

    Updates the preferences of the currently logged-in agent.

  • Write

    Upload My Photo

    Sets the profile photo for the currently logged-in agent. Note : To upload the photo, generate an OAuth token for the scope Desk.basic.UPDATE, profile.userphoto.UPDATE.

  • Write

    Schedule Agent Reassignment

    Schedules reassignment of tickets, tasks, and automations belonging to a deleted or deactivated agent to another agent within the same department.

  • Write

    Activate Agents

    Activates agents in your help desk.

  • Write

    Anonymize Deleted Agent

    Removes the identification details of a deleted agent.

  • Write

    Create Agent

    Creates an agent in your help desk. Note: The emailId, lastName, associatedDepartmentIds, and rolePermissionType fields are mandatory in the request. To assign the profile and role for the agent, pass one of the supported rolePermissionType values from the source documentation.

  • Write

    Update Agent

    Updates details of an agent.

  • Write

    Deactivate Agent

    Deactivates an agent in your help desk.

  • Write

    Reinvite Unconfirmed Agents

    Sends reinvitation mails to unconfirmed agents.

  • Write

    Update My Entity Preferences

    Updates entity preferences of the currently logged-in agent.

  • Destructive

    Delete Confirmed Agent

    Deletes a confirmed agent from your help desk.

  • Destructive

    Delete My Photo

    Deletes the profile photo of the currently logged-in agent.

  • Destructive

    Delete Unconfirmed Agents

    Deletes unconfirmed agents from your help desk.

Agent Presence

  • Read

    Get Agent Availability Configuration

    A limit can be set to determine how long an agent can remain inactive before their availability automatically changes to offline. Inactivity is defined when there is no interaction with the application, keystrokes or mouse movements.

  • Read

    Get Offline Agents

    This API lists the agents who are currently offline in a particular department.

  • Read

    Get Current Availability

    This API lists the current availability of agents in a particular department.

  • Read

    Get Online Agents

    This API lists the agents who are currently online in a particular department.

  • Write

    Update Agent Availability Configuration

    A limit can be set to determine how long an agent can remain inactive before their availability automatically changes to offline. Inactivity is defined when there is no interaction with the application, keystrokes or mouse movements.

Agent Signatures

  • Read

    Get Agent Signatures

    Retrieves the signature details of all agents.

  • Write

    Update Agent Signature

    Updates the signature of the specified agent. Pre-requisites: Agents require the Update Agent permission to update the signatures of other agents. Note: Agents do not require any special permissions to update their own signatures.

  • Write

    Update customized signatures of agent

    This API updates the customized signatures of an agent.

Agent Time Entry

  • Read

    List Agent Time Entries

    This API lists the time entries associated with an agent.

  • Read

    Get summation of Agent Time Entries

    This API fetches the sum of time entries associated with an agent.

  • Read

    Get an Agent Time Entry

    This API fetches a time entry related to an agent.

Article Attachment

  • Read

    Get Article Translation Attachments

    Retrieves the files attached to an article translation, with pagination support.

  • Read

    Get article attachments

    Lists article attachments.

  • Read

    Get docs resources info

    Gets docs resources information.

  • Write

    Upload Article Attachments

    Uploads files to the portal gallery for use in articles.

  • Write

    Upload and Attach File to Article Translation

    Uploads a file to the portal gallery and attaches it to an article translation.

  • Write

    Attach Files to Article Translation

    Attaches files selected from the portal gallery to an article translation.

  • Write

    Associate article attachment

    Associates attachments to article.

  • Write

    Upload and associate attachments

    This API uploads the files to the gallery section and attaches them to an article translation

  • Destructive

    Remove File Attachments from Article Translation

    Removes file attachments from an article translation.

  • Destructive

    Associate article attachment

    Associates attachments to article.

  • Destructive

    Delete article attachment

    Deletes article attachment.

Article Comment

  • Read

    Get Article Translation Comments

    Retrieves a list of comments on an article translation, with pagination support.

  • Read

    Get Moderated KB Comments

    Retrieves all available moderated comments from the knowledge base, with pagination support.

  • Read

    Get Moderated KB Comment Count

    Retrieves the total count of moderated comments from the knowledge base.

  • Read

    Get Article Translation Comment

    Retrieves a specific comment on an article translation.

  • Write

    Create Article Translation Comment

    Adds a comment to a specific article translation.

  • Write

    Approve Article Translation Comments

    Approves the specified article translation comments.

  • Write

    Move KB Comments to Recycle Bin

    Moves the specified KB article translation comments to the Recycle Bin.

  • Write

    Convert Article Translation Comment to Ticket

    Converts an article translation comment to a ticket and assigns it to the department configured for the root category.

  • Write

    Update Article Translation Comment

    Updates an existing comment on an article translation.

  • Destructive

    Delete Article Translation Comment

    Deletes a specific comment on an article translation.

Article Feedback

  • Read

    Get Article Translation Feedback comments

    Retrieves a list of feedback comments on a specific article translation, with pagination support.

  • Read

    Get details of feedback comment

    This API fetches the details of a particular feedback comment.

  • Read

    Get Article Feedback Comments

    Retrieves a list of feedback comments received on articles, with pagination support.

  • Write

    Create Article Feedback

    Creates a feedback comment for a specific article translation.

  • Write

    Update Article Feedback

    Updates the resolution status of an article feedback.

  • Write

    Convert Article Feedback to Ticket

    Converts an article feedback as a ticket in the help desk portal and assigns it to the author of the article.

  • Write

    Convert feedback comment into ticket

    This API adds a feedback comment as a ticket in your help desk portal and assigns it to the author of the article.

  • Destructive

    Delete Article Feedback

    Deletes a specific article feedback

  • Destructive

    Convert feedback comment into ticket

    This API adds a feedback comment as a ticket in your help desk portal and assigns it to the author of the article.

  • Destructive

    Delete feedback comment

    This API deletes a particular feedback comment from an article.

Article Feedback Resolution

  • Write

    Add Article Feedback Resolution

    Adds a resolution to a specific article feedback.

Article

  • Read

    Get Tags Associated with Articles

    Retrieves tags associated with articles, with pagination support.

  • Read

    List articles

    This API fetches a specific number of articles from your knowledge base, based on the limit defined.

  • Read

    Get article

    This API fetches an article from your knowledge base.

  • Read

    Validate permalink

    This API validates if a permalink is available for a help article.

  • Read

    Get article count

    This API returns the number of articles published in the knowledge base of your help desk portal.

  • Read

    Preview article

    This API shows a preview of help articles, through which you can check the content for formatting, alignment, and grammar/spelling errors and get the look and feel of the help article even before publishing it.

  • Read

    Get Suggested Articles for Ticket

    Retrieves help articles relevant to resolving a ticket, with pagination support.

  • Read

    Get Article History

    Retrieves the event history of an article, with pagination support.

  • Read

    Get Article Insights

    Retrieves basic insight metrics for a specific article.

  • Write

    Create article

    Creates a new article in the knowledge base.

  • Write

    Update Article

    Updates an existing article in the knowledge base.

  • Write

    Import File from Cloud

    Imports files from a cloud storage provider and converts them into HTML for publishing as articles.

  • Write

    Migrate External Images to KB Gallery

    Migrates external image URLs embedded in the provided article HTML content to the knowledge base gallery. Note: Images matching the specified class name can be excluded from migration.

  • Write

    Move articles to trash

    This API moves articles to the Recycle Bin

  • Write

    Stop Article Auto-Translation

    Stops auto-translation jobs that are currently in progress for one or more articles.

  • Write

    Restart Article Auto-Translation

    Restarts auto-translation jobs that have previously failed for one or more articles.

  • Write

    Share docs workspace

    Shares docs workspace.

Article Statistics

  • Read

    Get KB Article Statistics

    Retrieves statistical data related to help articles in the knowledge base.

  • Read

    Get Knowledge Base Trend

    Retrieves overall trend data for user actions recorded across the entire knowledge base.

  • Read

    Get Article Trend

    Retrieves trend data for user actions recorded on an article and all of its translations.

  • Read

    Get Top Article Translations

    Retrieves a ranked list of article translations based on user action counts.

  • Read

    Get Article Translation Interacted Users by Action Source

    Retrieves users who interacted with a translation, with extended filtering by action source.

  • Read

    Get Article Translation Interacted Users

    Retrieves users who interacted with a specific article translation.

  • Read

    Get Article Translation Action Counts

    Retrieves aggregated action counts for a specific article translation based on specified filters.

  • Read

    Get Article Interacted Users

    Retrieves users who interacted with a specific article.

  • Read

    Get Article Translation Interacted Users Count

    Retrieves the count of users who interacted with a specific article translation.

  • Write

    Reset Metrics of All Article Translations

    Resets metrics on all translations of an article for the specified actions.

  • Write

    Generate Top Articles Report

    Generates a real-time report of help articles that received the most user actions.

Article Translation

  • Read

    Get Article Translation Insights

    Retrieves basic insight metrics for a specific article translation.

  • Read

    Get translations of an article

    This API fetches the available translations of an article.

  • Read

    Search translations

    This API searches for the provided string from within the translation of articles.

  • Read

    Download Article Translation Attachment

    Downloads the content of a specific attachment associated with an article translation.

  • Read

    Get Article Translation by Translation ID

    Retrieves details of a specific article translation using its translation ID.

  • Read

    Get article translation

    This API fetches a specific translation of an article.

  • Read

    Get Multiple Article Translations

    Retrieves a list of translations across all articles, with pagination and filtering support.

  • Read

    Get Article Translation Answer

    Retrieves only the content of an article translation.

  • Read

    Extract Translation External Image URLs

    Retrieves external image URLs (other than KB gallery URLs) from a specific article translation.

  • Read

    Get Article Translation Count

    Retrieves the number of article translations based on specified filters.

  • Read

    Generate Article Translation Version Difference

    Generates the difference between two versions of an article translation.

  • Read

    Search Tags

    This API searches for the provided string from within the translation of articles.

  • Read

    Get concurrent edit status

    Gets concurrent edit status for an article translation.

  • Write

    Dislike translation

    This API adds a dislike (a negative reaction) to a translation.

  • Write

    Add translation

    This API adds a translated version of an article.

  • Write

    Clone Article Translation

    Creates a copy of a translated version of an article.

  • Write

    Trash an article translation

    This API moves an article translation to trash.

  • Write

    Edit translation

    This API edits an already translated article.

  • Write

    Migrate Translation External Images to KB Gallery

    Migrates external images from a specific article translation to the knowledge base gallery.

  • Write

    Like translation

    This API adds a like (a positive reaction) to a translation

Article Version

  • Read

    Get Article Translation Versions

    Retrieves the version history of an article translation.

Article Views

  • Read

    Get Article View Display Preference

    Retrieves a list of article view display preferences.

  • Write

    Update Article View Display Preference

    Updates the display preference for a specific article view in a department.

Automation Feature Count

  • Read

    Get Automation Feature Count

    Retrieves automation feature limits for the specified feature. For businesshours and holidaylist, no additional parameters are mandatory. For workflows, both module and departmentId are mandatory.

Backup

  • Read

    Get Bulk Export

    To get Bulk Export details.

  • Read

    Download Bulk Export File

    To download the exported data as a ZIP file

  • Write

    Initiate Bulk Export

    To initiate module Exports.

Badge

  • Read

    List badges

    This API lists a particular number of default and custom badges, based on the limit defined.

  • Read

    List User badges

    This API lists user's default and custom badges, based on the limit defined.

  • Write

    Add Badges to a user

    This API adds specified badges to user.

  • Destructive

    Remove Badges from user

    This API removes specified badges from the users.

Blueprint Drafts

  • Write

    Create Draft Blueprint

    Creates a new blueprint in draft state for review before publishing. Use this when building or iterating on a blueprint configuration without making it active. Requires the full blueprint configuration including states, transitions, connections, and chart data.

  • Write

    Update Draft Blueprint

    Updates an existing draft blueprint with the specified configuration changes. Use this to revise draft states, transitions, criteria, or chart layout before publishing.

  • Write

    Publish Draft Blueprint

    Publishes a draft blueprint. Use this when the draft configuration is finalized.

Blueprint

  • Read

    Get Blueprint Criteria Fields

    Retrieves the fields allowed in blueprint and transition criteria for the specified module and layout. Use this before building blueprint or transition criteria rules. Available pre-defined values include @${EMPTY}@, @${NOTEMPTY}@, @${OPEN}@, @${CLOSED}@, and @${CURRENTTIME}@.

  • Read

    Get Configurable Blueprint Fields

    Retrieves the field details that can be configured in blueprints for the specified layout and module. Use this before creating or editing a blueprint to discover which ticket fields can be mapped to the blueprint workflow.

Blueprints

  • Read

    List all blueprints in a department

    Retrieves a list of blueprints for the specified module.

  • Read

    Get Applied Blueprint details of ticket for a user

    To get the applied blueprint details of a ticket

  • Read

    Get Blueprint Details

    Retrieves the details of a specific blueprint including its states, transitions, connections, and chart configuration.

  • Read

    Check Blueprint Applied for Entity

    Checks whether a blueprint is associated with or applied to any entity (record). Use this before deleting or deactivating a blueprint to confirm it is not currently in use on tickets or other records.

  • Write

    Create Blueprint

    Creates a new blueprint with the specified states, transitions, connections, and chart configuration.

  • Write

    Reorder blueprints

    Reorders blueprints in the specified department for a given module.

  • Write

    Update a blueprint

    Updates an existing blueprint with the specified configuration changes.

  • Destructive

    Delete Blueprint

    Deletes a specific blueprint permanently.

  • Destructive

    Revoke Blueprint from Blueprint Level

    Revokes the specified blueprint from all records it is currently applied to, removing it from the active execution flow.

  • Destructive

    Revoke Blueprint from Multiple Tickets

    Revokes the blueprint from multiple tickets simultaneously. Use this to bulk-remove blueprint enforcement from records. Pass up to 50 ticket IDs in the request body; IDs for which revocation failed are returned in failureIds.

  • Destructive

    Revoke Blueprint at Entity Level

    To revoke blueprint from an entity

Blueprint Transitions

  • Read

    View a specific attachment added to a transition draft

    Downloads the file content of a specific attachment added to a transition draft.

  • Read

    Get transition form details

    Retrieves the during-transition form details and available actions for a given transition on a ticket.

  • Write

    Perform a blueprint transition on a ticket

    Execute a blueprint transition on the specified ticket. Supply form-action payloads for approval, resolution, attachment, reply, comment, sharing, and field-update actions as required by the transition configuration.

  • Destructive

    Delete attachment of a transition draft

    Deletes a specific attachment added to a transition draft.

Bug Integ

  • Read

    Get Linked Tickets by Bug ID

    Retrieves support tickets associated with the specified bug.

Business Hour

  • Read

    Get Business Hours Set

    Retrieves the details of a business hours set configured in the help desk portal.

  • Read

    Get Business Hours Sets

    Retrieves business hours sets, with pagination support.

  • Read

    Get Associated Automation Rules

    Retrieves automation rules associated with the specified business hours set, with pagination support.

  • Write

    Update Business Hours Set

    Updates the details of a business hours set configured in the help desk portal.

  • Write

    Create Business Hours Set

    Creates a business hours set in the help desk portal.

  • Destructive

    Delete Business Hours Set

    Deletes a business hours set from the help desk portal.

Call Attachment

  • Write

    Create call attachment

    This API attaches a file to a call.

  • Destructive

    Delete call attachment

    This API deletes an attachment from a call.

Call Comments

  • Read

    Get a call comment

    This API fetches a call comment from the portal.

  • Read

    List all call comments

    This API lists a particular number of comments recorded on a call, based on the limit specified.

  • Write

    Partially update a call comment

    This API partially updates an existing call comment.

  • Write

    Create a call comment

    This API adds a comment to a call.

  • Destructive

    Update a call comment

    This API updates an existing call comment.

  • Destructive

    Delete a call comment

    This API deletes an existing call comment.

Call

  • Read

    Get call

    This API fetches the details of a call.

  • Read

    List calls

    This API fetches a particular number of calls, based on the limit specified.

  • Read

    List calls by ticket

    This API lists a particular number of calls associated with a ticket, based on the limit specified.

  • Write

    Update many calls

    This API updates multiple calls at once.

  • Write

    Update call

    This API updates the details of a call.

  • Write

    Clear live call mapping from an activity

    This API clears the live call mapping from an activity

  • Write

    Create call

    This API adds a call entry to your help desk portal.

  • Write

    Empty spam calls

    This API deletes all spam calls.

  • Destructive

    Delete calls

    This API moves call entries to the Recycle Bin of your help desk portal.

  • Destructive

    Delete spam calls

    This API deletes the given spam calls

Channel

  • Read

    Get Channel logo

    This API gets the logo for the given channel.

  • Read

    Get a Channel

    This API gets fetches details of a given channel.

  • Read

    List configured channels

    This API fetches currently installed channels including System, Channel integration and Instant Messaging channels

  • Write

    Update Channel logo

    This API updates the logo for the given channel. Logo of SYSTEM channels cannot be updated.

Community Attachment

  • Read

    Get Unassociated Attachment

    Retrieves an unassociated attachment from the user community. Unassociated attachments are files uploaded to a community topic or comment that is not yet published or saved as a draft.

  • Write

    Upload Attachment

    Uploads a file to the storage space allocated for the community module.

Community Category

  • Read

    Get All Categories

    Retrieves all community categories for the setup page.

  • Read

    Get Categories

    Retrieves a list of community categories.

  • Read

    Get Category or Forum Followers

    Retrieves users who follow a community category or forum, with pagination support.

  • Read

    Get Category or Forum

    Retrieves the details of a community category or forum.

  • Write

    Disable Category or Forum

    Disables a community category or forum to restrict posting access.

  • Write

    Enable Category or Forum

    Enables a community category or forum to provide posting access.

  • Write

    Follow Category or Forum

    Subscribes the authenticated user to follow a community category or forum.

  • Write

    Unfollow Category or Forum

    Unsubscribes the authenticated user from following a community category or forum.

  • Write

    Lock Category or Forum

    Locks a community category or forum to restrict posting access.

Community Category Logo

Community Comment

  • Read

    Get Comments Pending Moderation

    Retrieves comments that are pending moderation, with pagination support.

  • Read

    Get Comments Views Count

    This API fetches the total count of the comments based on the selected view.

  • Read

    Get Comment

    Retrieves a comment posted on a community topic.

  • Read

    Get Comments by User

    Retrieves comments posted by a community user, with pagination support.

  • Read

    Get Comments

    Retrieves a list of comments on a community topic, with pagination support.

  • Write

    Report Comment as Spam

    Marks a comment on a community topic as spam.

  • Write

    Report Comments as Spam

    Marks multiple comments on community topics as spam.

  • Write

    Restore community topic trashed comments

    This API restores comments that were trashed from forum topics.

  • Write

    Update Comment

    Updates a published comment on a community topic.

  • Write

    Move Comment to Recycle Bin

    Moves a comment on a community topic to the Recycle Bin.

  • Write

    Approve community topic comments

    This API approves comments that are pending moderation.

  • Write

    Create Reply

    Adds a reply to a comment on a community topic.

  • Write

    Move Reply to Recycle Bin

    Moves a reply to a community topic comment to the Recycle Bin.

  • Write

    Update Reply

    Updates a published reply on a community topic comment.

  • Write

    Trash unmoderated community topic comments

    This API trashes comments that are yet to be approved for publishing on a forum topic.

  • Write

    Create Comment

    Adds a comment to a community topic.

  • Destructive

    Permanently delete topic comments

    This API permanently deletes comments from the trash of your help desk portal.

Community

  • Read

    Get Topic Attachment

    Retrieves a file attachment from a community topic.

  • Read

    Get Topic Voters Trend

    Retrieves the voting trend for a community topic over time.

  • Read

    Get Reply Attachment

    Retrieves a file attachment from a reply to a topic comment.

  • Read

    Get community topic comment attachment

    This API fetches a file attachment from a topic comment.

  • Write

    Move Topic to Recycle Bin

    Moves a community topic to the Recycle Bin.

  • Write

    Lock Topic

    Locks a community topic to restrict further user actions.

Community Preferences

  • Read

    Get Community Preferences

    Retrieves the settings defined for the user community.

  • Read

    Get moderation stats

    This API fetches statistics related to topic/comment moderation in the user community.

  • Write

    Set Community Preferences

    Defines the settings for the user community.

Community Topic

  • Read

    Get Ticket Associated with Topic

    Retrieves the ticket created from a community topic.

  • Read

    Get Topics

    Retrieves a list of community topics, with pagination support.

  • Read

    Get Topic

    Retrieves the details of a forum topic from the user community.

  • Read

    Get Topic Followers

    Retrieves users who follow a community topic, with pagination support.

  • Read

    Get Topics Pending Moderation

    Retrieves topics that are pending moderation, with pagination support.

  • Read

    Get Topic Participants

    Retrieves users who participated in a community topic, with pagination support.

  • Read

    Search Topics

    Retrieves community topics that match the provided keywords, with pagination support.

  • Read

    Get Topics Count

    Retrieves the total count of community topics based on the selected view

  • Read

    Get Topic Types

    Retrieves the topic types defined in the user community, including the default, enabled, and disabled types.

  • Read

    Get Moderated Topics

    Retrieves topics that have been moderated, with pagination support.

  • Read

    Get Topics by User

    Retrieves topics posted by a community user, with pagination support.

  • Read

    Get Topic Voters

    Retrieves users who voted on a community topic, with pagination support.

  • Read

    Get Topic Drafts

    Retrieves all topic drafts of the current user, with pagination support.

  • Write

    Unmoderate Topic

    Removes moderation from a community topic. User comments are published without review.

  • Write

    Create Topic

    Creates a new topic in the community forum.

  • Write

    Associate Tags to Topic

    Associates quick access or reference tags to a community topic.

  • Write

    Approve Topics

    Approves community topics and publishes them on the forum.

  • Write

    Report Topic as Spam

    Marks a community topic as spam.

  • Write

    Update Topic

    Updates an existing published community topic.

  • Write

    Update Topics

    Updates a property of multiple community topics at once.

  • Write

    Dissociate Tags from Topic

    Removes quick access or reference tags from a community topic.

  • Write

    Unmoderate community topics

    This API unmoderate the moderated forum topics.The comments that are posted during moderation will be displayed to all users without under going any review.

  • Write

    Report Topics as Spam

    Marks multiple community topics as spam.

  • Write

    Unlock Topic

    Unlocks a community topic to allow further user actions.

  • Write

    Create Topic Draft

    Saves a draft of a community topic.

  • Write

    Create Tickets for Topics

    Creates a separate ticket for each community topic provided in the list.

  • Write

    Unfollow Topic

    Unsubscribes the authenticated user from following a community topic.

  • Write

    Trash unmoderated community topics

    This API trashes forum topics that are yet to be moderated for publishing.

  • Write

    Unlike Topic

    Removes a like from a community topic for the authenticated user.

  • Write

    Update Topic Type Preferences

    Updates the default topic type and enables topic types in the user community.

  • Write

    Follow Topic

    Subscribes the authenticated user to follow a community topic.

  • Write

    Moderate Topic

    Sets a community topic to moderated status. Comments posted during moderation are not displayed to users and await review.

  • Write

    Move Topic

    Moves a community topic from one category or forum to another.

  • Write

    Restore trashed topics

    This API restores topics from trash.

  • Write

    Add Topic as Ticket

    Converts a single community topic into a support ticket.

  • Write

    Like Topic

    Adds a like to a community topic for the authenticated user.

  • Write

    Publish Topic Draft

    Publishes the draft of a community topic. The topic status changes from DRAFT to PUBLISHED.

  • Destructive

    Delete Topics from Recycle Bin

    Permanently deletes community topics from the Recycle Bin.

  • Destructive

    Update Topic Draft

    Updates an existing community topic draft.

  • Destructive

    Delete Topic Draft

    Deletes a community topic draft.

Community User

  • Read

    Get User

    Retrieves the details of a community user.

  • Read

    Get User Followers

    Retrieves users who follow a community user, with pagination support.

  • Read

    Get Moderated Users

    Retrieves end-users who are currently under moderation, with pagination support.

  • Write

    Update User Status

    Updates the moderation status of an end-user in the community.

  • Write

    Unmoderate community users

    This API disables moderation for end-users in the user community.

  • Write

    Follow User

    Subscribes the authenticated user to follow a community user.

  • Write

    Unfollow User

    Unsubscribes the authenticated user from following a community user.

Contact Attachment

  • Read

    Get Contact Attachments

    Retrieves the files attached to the specified contact, with pagination support.

  • Write

    Create Contact Attachment

    Creates an attachment for the specified contact.

  • Destructive

    Delete Contact Attachment

    Deletes an attachment from a contact.

Contact Comments

  • Read

    List all contact comments

    This API lists a particular number of comments recorded on a contact, based on the limit specified.

  • Read

    Get a contact comment

    This API fetches a contact comment from the portal.

  • Write

    Create a contact comment

    This API adds a comment to a contact.

  • Destructive

    Update a contact comment

    This API updates an existing contact comment.

  • Destructive

    Delete a contact comment

    This API deletes an existing contact comment.

Contact Deduplication

  • Read

    List duplicate contacts

    This API lists the duplicate entries of a contact.The fieldName parameters is mandatory in the API request Note: If you encounter a 202 status code while executing this API request, it means there are 100,000 or more contacts in the help desk portal.

  • Read

    Get name of default field

    This API fetches the name of the field set as the default field for contact deduplication.

  • Read

    List details of duplicate contacts

    This API lists all the details of duplicate contacts.The fieldName and fieldValues parameters are mandatory in the API request

  • Write

    Set default field for contact deduplication

    This API sets the field you specify as the default field for deduplicating contacts.

Contact Followers

  • Read

    Get Contact Followers

    Retrieves the list of users following a contact, with pagination support. Followers track the tickets raised by the contact and the support provided.

  • Write

    Add Contact Followers

    Adds one or more users to the followers list of a contact. Followers track the tickets raised by the contact and the support provided.

  • Destructive

    Remove Contact Followers

    Removes one or more users from the followers list of a contact. Followers track the tickets raised by the contact and the support provided.

Contact

  • Read

    List contacts associated with product

    This API lists the contacts associated with a product.

  • Read

    Get contact statistics

    This API fetches the overall statistics of an contact.

  • Read

    Get status of contact in help centers

    This API fetches a particular contact's activation status in all the help centers they are part of.

  • Read

    Get contact history

    This API fetches the ticket history of a contact.

  • Read

    List Contacts

    This API lists a particular number of contacts, based on the limit specified.

  • Read

    Get contacts count

    This API displays the count for the number of contacts in a custom view

  • Read

    List Contacts By Ids

    This API lists details of specific contacts, based on the IDs passed in the request.

  • Read

    Get Contact

    This API fetches a single contact from your help desk portal.

  • Read

    List Associated contacts

    This API lists the contacts associated with an account

  • Write

    Invite multiple contacts to help center

    This API helps invite multiple contacts as end-users to your help center.

  • Write

    Dissociate accounts from contact

    This API dissociates multiple accounts from a particular contact.

  • Write

    Dissociate account from contact

    This API dissociates a particular account from a contact.

  • Write

    Create Contact

    This API creates a contact in your help desk portal.

  • Write

    Update many contacts

    This API updates multiple contacts at once.

  • Write

    Update Contact

    This API updates details of an existing contact.

  • Write

    Merge Contacts

    This API merges two or more contacts Note: Though portal users (users who signed up via the help center) are saved as contacts in the help desk, their records cannot be merged with other records/contacts.

  • Write

    Approve contact for help center

    This API helps approve a particular contact as an end-user to your help center.

  • Write

    Reject contact for help center

    This API helps reject a particular contact from being added as an end-user to your help center.

  • Write

    Associate accounts with contact

    This API associates multiple accounts with a particular contact.

  • Write

    Associate products with a contact

    This API associates products with a contact. Only a maximum of 10 products can be associated with a contact through a single API request.

  • Write

    Mark contact as spam

    This API marks contacts as spam.

  • Write

    Invite contact to help center

    This API helps invite a particular contact as an end-user to your help center.

  • Destructive

    Delete contact photo

    This API deletes the display picture of a contact.

  • Destructive

    Delete Contacts

    This API moves the contacts specified to the Recycle Bin.

  • Destructive

    Delete spam contacts

    This API deletes the given spam contacts

Contact Profile

  • Read

    Get Contact Profiles

    This api fetches the list of profiles of this contact from various channels.

Contact Time Entry

  • Read

    Get summation of Contact Time Entries

    This API fetches summation of time entries for a contact from your help desk

  • Read

    List Contact Time Entries

    This API lists time entries recorded for a ticket or task related to a contact.

Contract Comments

  • Read

    Get Contract Comments

    Retrieves comments recorded on a contract, with pagination support.

  • Read

    Get Contract Comment

    Retrieves a specific comment from a contract.

  • Read

    Download contract comment attachment content

    This API downloads the content of an attachment associated with a contract comment.

  • Write

    Create Contract Comment

    Adds a comment to a specific contract.

  • Write

    Update Contract Comment

    Updates an existing comment on a specific contract.

  • Destructive

    Update Contract Comment

    Updates an existing comment on a specific contract.

  • Destructive

    Delete a contract comment

    This API deletes a contract comment.

Contract

  • Read

    Get Contracts

    Retrieves a list of contracts in the help desk portal, with pagination support.

  • Read

    Get Contract

    Retrieves the details of a specific contract.

  • Read

    Get Contracts Count

    Retrieves the number of contracts for the specified view.

  • Write

    Update Contracts

    Updates multiple contracts at once by applying a field value change to the specified contract IDs.

  • Write

    Create Contract

    Creates a new contract in the help desk portal.

  • Write

    Update Contract

    Updates the details of an existing contract.

  • Destructive

    Update Contract

    Updates the details of an existing contract.

Countries And Languages

  • Read

    Get Countries

    Retrieves the countries that can be set in the locale field in Zoho Desk. Note: The countries object in the response will be deprecated soon. Use the data object instead.

  • Read

    Get Languages

    Retrieves the languages that are available for listing in Zoho Desk.

  • Read

    Get Time Zones

    Retrieves the time zones that are available for listing in Zoho Desk.

Customer Happiness

  • Read

    Get the customer feedback placeholder link

    This API provides an html placeholder to insert the customer feedback link into the reply mail. The link, when clicked by the email recipient, leads them to a feedback form where they can provide their feedback.

Custom View

  • Read

    Get Last Accessed View

    Retrieves the view last accessed by the user in the module and department specified in the request.

  • Read

    Get Views

    Retrieves a list of views configured for a specific module in your help desk portal, with pagination support.

  • Destructive

    Update Last Accessed View

    Updates the view last accessed by the user in the module and department specified in the request.

Dashboard Metrics

  • Read

    Get on hold tickets count

    Retrieves the number of tickets that are in the 'on hold' status.

  • Read

    Get closed tickets count

    This API fetches the number of tickets that are resolved.

  • Read

    Get unresolved tickets count

    Retrieves the number of tickets that have remained unresolved over a particular period.

  • Read

    Get reopened tickets count

    Retrieves the number of tickets that were reopened in your help desk portal.

  • Read

    Get resolution times

    Lists the duration taken to resolve tickets.

  • Read

    Get created tickets count

    Retrieves the number of tickets created in a particular duration.

  • Read

    Get total response count

    Retrieves the total number of responses sent by agents.

  • Read

    Get response times

    Lists the duration taken to respond to tickets.

Department

  • Read

    Get Department

    Retrieves the details of a department from the help desk.

  • Read

    Get Departments by IDs

    Retrieves the details of the departments whose IDs are passed in the request.

  • Read

    Get Agents in Department

    Retrieves the agents in a department.

  • Read

    Get Department Count

    Retrieves the number of departments configured in the help desk portal.

  • Read

    Get Associable Agents in Department

    Retrieves the associable agents in a department, with pagination support.

  • Read

    Get Departments

    Retrieves departments, with pagination support.

  • Read

    Check for duplicate departments

    This API checks if multiple departments have the same name.

  • Read

    Get My Departments

    Retrieves departments associated with the current user.

  • Write

    Associate Agents to Department

    Associates agents to a department.

  • Write

    Update Department

    Updates the details of an existing department.

  • Write

    Enable Department

    Enables a department in the help desk portal.

  • Write

    Disable Department

    Disables a department in the help desk portal.

  • Write

    Dissociate Agents from Department

    Dissociates agents from a department.

  • Write

    Create Department

    Creates a department in the help desk portal.

Dependency Mappings

  • Read

    Get Dependency Mappings Count For Layout

    This API gets dependency mapping count details for a layout.

  • Read

    Get possible dependency mappings in a layout

    This API fetches the parent and child fields using which you can configure dependency mappings in a layout.

  • Read

    Get dependent child field values

    This API fetches the dependent child field values for a given parent field value in a layout.

  • Read

    List dependency mappings in a layout

    This API lists the dependency mappings configured in a layout.

  • Read

    Get dependency mapping

    This API fetches details of an existing dependency mapping.

  • Write

    Create dependency mapping

    This API creates a dependency mapping between two fields.

  • Write

    Update dependency mapping

    This API updates details of an existing dependency mapping.

  • Destructive

    Delete dependency mapping

    This API deletes a dependency mapping from a layout.

Direct Assignment Rules

  • Read

    Get Direct Assignment Rule

    Retrieves the details of a specific direct assignment rule

  • Read

    Get Direct Assignment Rules

    Retrieves a list of all direct assignment rules

  • Read

    Get Direct Assignment Rule Target

    Retrieves a specific target in a direct assignment rule

  • Read

    Get Direct Assignment Rule Criteria Fields

    Lists the fields allowed in criteria for direct assignment rules. Available pre-defined values may contain ${EMPTY}, ${NOTEMPTY}, ${OPEN}, ${CLOSED}, and ${CURRENTTIME}. Available types are Text, Date, DateTime, Boolean, and Arithmetic.

  • Read

    Get Direct Assignment Rules Execution Status

    Retrieves the current execution status of direct assignment rules

  • Write

    Update Direct Assignment Rule

    Partially updates a direct assignment rule

  • Write

    Create Direct Assignment Rule

    Creates a new direct assignment rule

  • Write

    Reorder Direct Assignment Rules

    Reorders the direct assignment rules

  • Write

    Create Direct Assignment Rule Target

    Creates a target for a direct assignment rule

  • Write

    Update Direct Assignment Rule Target

    Partially updates a target in a direct assignment rule

  • Destructive

    Update Direct Assignment Rule

    Updates a direct assignment rule

  • Destructive

    Update Direct Assignment Rule Target

    Updates a target in a direct assignment rule

  • Destructive

    Update Direct Assignment Rules Execution Status

    Enables or disables the execution of direct assignment rules

Direct Assign Rule Target

  • Read

    Get Direct Assignment Rule Target

    Retrieves a specific target in a direct assignment rule

Display Entity

  • Write

    Auto Display an Entity

    This API is used to instruct an agent's browser to open and display a given entity automatically without any manual action required by the agent.

Domain Mapping

  • Read

    Get Domain

    Retrieves the details of the domain configured in the help desk.

  • Read

    Get Domains

    Retrieves the domains configured in the help desk.

  • Write

    Apply Domain

    Maps a domain to the default portal in the help desk.

  • Write

    Add Domain

    Adds a domain to the help desk.

  • Write

    Verify Domain

    Verifies a domain in the help desk.

  • Write

    Reset Domain

    Resets the current domain of the default portal in the help desk.

  • Destructive

    Delete unused domain

    This API deletes unused domain from your help desk.

Email Failure Alert

  • Read

    List email delivery failure alerts

    This API lists the email delivery failure alerts configured in a particular department.

  • Write

    Clear email delivery failure alerts

    This API deletes all email delivery failure alerts configured in a particular department.

Email Templates

  • Read

    Get Templates

    Retrieves a list of email templates for the specified department, with pagination support.

  • Read

    Get Placeholders

    Retrieves the list of placeholders supported in email templates for the specified module and department.

  • Read

    Get Template

    Retrieves details of a specific email template.

  • Write

    Create Template

    Creates a new email template.

  • Write

    Clone Template Attachments

    Clones the attachments of an existing template for reuse.

  • Write

    Update Template

    Updates an existing email template.

  • Write

    Render Template

    Renders an existing template by replacing placeholders with actual entity data.

  • Destructive

    Update Template

    Updates an existing email template.

  • Destructive

    Delete Template

    Deletes a specific email template.

Entity Blueprints

  • Write

    Save the during actions transition draft

    Saves the during-actions transition draft for a specific transition on a ticket.

  • Destructive

    Delete the during actions transition draft

    Deletes the during-actions transition draft for a specific transition on a ticket.

Event Attachment

  • Read

    List event attachments

    List the files attached to the specified event.

    GET /api/v1/events/{eventId}/attachments

  • Read

    Retrieve event attachment content

    Retrieve the content of an attachment associated with the specified event.

    GET /api/v1/events/{eventId}/attachments/{attachmentId}/content

  • Write

    Create event attachment

    Attach a file to the specified event.

    POST /api/v1/events/{eventId}/attachments

  • Destructive

    Delete event attachment

    Remove the specified attachment from an event.

    DELETE /api/v1/events/{eventId}/attachments/{attachmentId}

Event Comments

  • Read

    List all event comments

    This API lists a particular number of comments recorded on a event, based on the limit specified.

  • Read

    Get a event comment

    This API fetches a event comment from the portal.

  • Write

    Create a event comment

    This API adds a comment to a event.

  • Destructive

    Update a event comment

    This API updates an existing event comment.

Event

  • Read

    List events

    This API lists a particular number of events, based on the limit specified.

  • Read

    Get event

    This API fetches the details of an event.

  • Read

    List events by ticket

    This API lists a particular number of events associated with a ticket, based on the limit specified.

  • Write

    Create event

    This API adds an event entry to your help desk portal.

  • Write

    Update an event

    This API updates the details of an event.

  • Write

    Update many events

    This API updates multiple events at once.

  • Write

    Empty spam events

    This API deletes all spam events.

  • Destructive

    Delete spam events

    This API deletes the given spam events

  • Destructive

    Delete events

    This API moves event entries to the Recycle Bin of your help desk portal.

Field

  • Read

    Get field

    Retrieves the details of a single field by its ID.

  • Read

    Get Fields

    Retrieves fields for the specified module.

  • Write

    Update field

    Updates an existing field by its ID.

  • Write

    Create field

    Creates a new field for the specified module.

  • Destructive

    Delete field

    Deletes an existing field by its ID.

Organization Fields

  • Read

    Get organization custom fields criteria references

    This API fetches criteria references of a custom field

Field Old

  • Read

    Get Custom Field Count

    This API returns the custom field count allowed and available in a module.

Field Permissions

  • Read

    Get Field Permissions

    Retrieves field permissions for all profiles

  • Write

    Update Field Permissions

    Updates field permissions for the specified profiles

Finance

  • Read

    Get Invoices

    Retrieves invoices associated with the specified Desk entity.

  • Read

    Get Estimates

    Retrieves estimates associated with the specified Desk entity.

  • Read

    Get Tickets for Invoice

    Retrieves tickets associated with the specified invoice.

  • Write

    Update Estimate Status

    Updates the status of a specific estimate.

  • Write

    Update Invoice Status

    Updates the status of a specific invoice.

  • Write

    Mark Invoices as Sent

    Updates the status of multiple invoices to sent.

Followers

  • Read

    Get Entity Followers Count

    Retrieves the count of followers for the specified entity, with optional filtering by user type.

  • Read

    Get Entity Followers

    Retrieves the list of followers for the specified entity, with pagination support.

  • Read

    Get My Followed Entities

    Retrieves the list of entities followed by the current user, filtered by entity type, with pagination support.

  • Write

    UnFollow Entity

    Removes the follow relationship between the current user and the specified entity.

  • Write

    Follow Entity

    Creates a follow relationship between the current user and the specified entity.

Generic Action

  • Write

    Execute Action

    This API executes an action with the given input values.

Helpcenter Groups

  • Read

    List users in a group

    This API lists a particular number of users in a group, based on the limit defined.

  • Read

    Get details of group

    This API fetches the details of a particular user group.

  • Read

    List helpcenter groups

    This API lists a particular number of groups, based on the limit defined.

  • Write

    Update group

    This API helps update the details of a user group.

  • Write

    Create user groups

    This API creates a user group in your help center.

  • Write

    Add users to group

    This API adds users to a particular group.

  • Destructive

    Delete helpcenter user group

    This API deletes a user group from your help center.

  • Destructive

    Remove users from group

    This API removes particular users from a group.

Helpcenter

  • Read

    List help centers

    This API lists the help centers configured in your Zoho Desk portal.

  • Read

    Get details of help center

    This API fetches the details of a particular help center.

  • Write

    Update Helpcenter sitemaps

    This API will generate sitemaps for the given Helpcenter

Holiday List

  • Read

    Get Holiday Lists

    Retrieves holiday lists, with pagination support.

  • Read

    Get Holiday List

    Retrieves the details of a holiday list configured in the help desk portal.

  • Write

    Create Holiday List

    Creates a holiday list in the help desk portal.

  • Write

    Update Holiday List

    Updates the details of a holiday list configured in the help desk portal.

IM Add On

  • Read

    Get AddOn Package Details

    Retrieves add-on package details for the specified integration service.

  • Read

    Get IM Payment Statement

    Retrieves IM credit statement entries for the org, with pagination support.

IM Bot

  • Read

    Get IM Bot

    Retrieves the details of a specific IM bot. The response always includes creator and preference. preference may be null when no preference is configured.

  • Read

    Get IM Bots

    Retrieves a list of IM bots configured for the org, with pagination support. Pass include=creator to include creator details in each list item.

IMCanned Message

  • Read

    Get IM Template Message

    Retrieves details of a specific template message.

  • Read

    Get IM Template Messages

    Retrieves a list of IM template messages for the specified department, with pagination support.

  • Write

    Apply template message

    Retrieves a template message with contact information applied to the placeholders.

IM Channel

  • Read

    Get Channel

    Retrieves details of a specific IM channel.

  • Read

    Get Channels

    Retrieves a list of channels, with pagination support.

  • Write

    Create an IM channel

    Creates a new IM channel for the org. Required fields are name and integrationServiceId. Optional fields include configParams (integration-specific credentials), meta, defaultBotId, isSandBox. If isSandBox is omitted, it defaults to false.

IM Integration

  • Read

    List WhatsApp phone numbers

    Returns the list of WhatsApp phone numbers available under the linked WhatsApp Business Accounts for the current org. Use the optional wabaId query parameter to filter by a specific WABA. Include CHANNELSCONFIGURED or COMMERCESETTINGS to fetch additional metadata per number.

  • Read

    Get template credit exhaust status

    Checks whether sufficient WhatsApp template-message credits remain for the given receiver and channel.

  • Read

    Get WhatsApp sandbox testers

    Retrieve the list of phone numbers registered as sandbox testers for the WhatsApp channel. Sandbox testers are used to validate messaging behavior on the Zoho Desk portal before onboarding the official business phone number.

  • Read

    Request WhatsApp phone number OTP

    Triggers an OTP verification code to be sent to the specified WhatsApp phone number via SMS or voice call. This API is used when the phone number's codeVerificationStatus is EXPIRED or NOTVERIFIED. Use the mode query parameter to choose the delivery method (sms or voice).

  • Read

    List WhatsApp template tag categories

    Returns allowed WhatsApp Cloud API template category tags (for example UTILITY, MARKETING) for the WHATSAPP integration in the organization.

  • Read

    Get WhatsApp integration details

    Returns WhatsApp Business Account (WABA) metadata, per-WABA phone number status, and aggregate WABA approval state for the WHATSAPP integration.

  • Read

    List WhatsApp template supported languages

    Returns the list of language codes and display names supported for WhatsApp template messages for the WHATSAPP integration (data array, kind discriminator).

  • Write

    Add or update WhatsApp sandbox testers

    Add or update the list of sandbox tester phone numbers for the WhatsApp channel. Use this endpoint to register numbers that will receive test messages through the sandbox environment. Each number must start with a plus sign followed by numerals (e.g. +13312040199).

  • Write

    Submit WhatsApp phone number OTP

    Submits the 6-digit OTP verification code received on the specified WhatsApp phone number to complete the number verification process. On success the phone number's codeVerificationStatus changes to VERIFIED.

IM Integration Service

  • Read

    Get integration service by id

    Returns metadata for one IM integration service (for example WhatsApp or LINE), including display fields and, in the full payload, configParams and pricingParams used when configuring channels.

  • Read

    List available IM integration services

    Returns the integration service types available to the current Desk org for Instant Messaging (for example WhatsApp, Telegram, LINE). Use this before creating channels or loading service-specific configuration. Response shape follows Desk list conventions (data, kind, hasMore).

  • Write

    Compute options for an integration service config parameter

    Compute options for an integration service config parameter

IM Message

  • Read

    Get Session Message

    Retrieves details of a single message in the specified IM session.

  • Read

    Get Message Full Content

    Retrieves the full content of a message in the specified IM session.

  • Read

    Get Session Messages

    Retrieves messages in the specified IM session, with pagination support.

  • Read

    Get Session Attachments

    Retrieves attachments in the specified IM session, with pagination support.

  • Read

    Get Session Last Messages

    Retrieves the last message for each specified IM session.

  • Read

    Get Attachment Content

    Downloads the content of an attachment in the specified IM session.

  • Write

    Initiate Session

    Initiates a session with a template message. This API is used only for WhatsApp Integration.

  • Write

    Start Facebook Messenger Session

    Starts a Facebook Messenger session outside the standard messaging window using the Facebook comment ID and Facebook user ID from a post where the user interacted. Prerequisites: In facebookMessengerPayload, facebookUserId and facebookCommentId must be provided.

  • Write

    Add Outgoing Message

    Adds an outgoing message to an IM session. This API can be called only when the session is assigned to the current agent. If the session is unassigned or assigned to another agent, use the Update Session API to pick up the session first, then send the message.

  • Write

    Send Attachment Message

    Sends a file attachment to the specified IM session.

IM Metrics

  • Read

    Get Agents Metrics

    Retrieves agent performance metrics for IM sessions. This data provides leads and managers with holistic details into agent performance and can be used for coaching them.

  • Read

    Get Session Metrics

    Retrieves session-related metrics such as average first response time, average response time, and average pickup time, with time-series granularity.

Import

  • Read

    Get Import Mappings

    This API fetches entity id's for given external ids your help desk portal.

  • Read

    Get Import

    This API fetches a single import info from your help desk portal.

  • Write

    Create Import

    This API add a import entry under a given scope in your help desk portal.

IM Search

  • Read

    Search IM Messages

    This API searches IM messages and returns message list-view details with an embedded session per result. Use searchStr or message to filter by text. Use from and limit to paginate results. Use sortBy and sortOrder to control result ordering.

IM Session

  • Read

    Get Session Metrics

    Returns session counts grouped by assignee filter and session status. Use optional query parameters to narrow results by department, channel, or integration service.

  • Read

    Get Session Tickets

    Retrieves tickets associated with the specified IM session, with pagination support.

  • Read

    List Sessions

    This API lists all sessions

  • Read

    Get a session

    This API fetches details of an session.

  • Write

    Update a session

    This API updates details of a session, including its status and assignee. Use it to assign the session to yourself or another agent by passing agentId with an appropriate status value. To assign a bot, pass botId with deskBotId from List IM Bots.

IM Time Series Metrics

  • Read

    Get Message Time-Series Metrics

    Retrieves IM message metrics over time by direction, with time-series granularity.

  • Read

    Get Conversation Time-Series Metrics

    Retrieves IM conversation metrics over time by status or contact type, with time-series granularity.

  • Read

    Get Payment Time-Series Metrics

    Retrieves IM WhatsApp credit usage metrics over time, with time-series granularity.

Jira Integ

  • Read

    Get Linked Tickets

    Retrieves support tickets associated with the specified Jira issue.

Kb Category

  • Read

    Get articles for manual sorting

    This API lists the positions of help articles to enable manual sorting. Only leaf categories that have a maximum of 1000 articles can be repositioned.

  • Write

    Update article position

    This API helps you manually sort articles in your knowledge base. Only leaf categories that have a maximum of 1000 articles can be repositioned.

KBCategory

  • Destructive

    Delete category

    Deletes a KB category.

Kb Category Logo

KBRecycle Bin

  • Read

    Get Trashed KB Comments

    Retrieves a list of KB article translation comments that are in the Recycle Bin, with pagination support.

  • Read

    Get Trashed Article Translations Count

    Retrieves the total count of article translations in the Recycle Bin.

  • Read

    Get Trashed KB Categories Count

    Retrieves the total count of KB categories in the Recycle Bin.

  • Read

    Get Trashed KB Comments Count

    Retrieves the total count of KB article translation comments in the Recycle Bin.

  • Read

    Get Trashed Article Translations

    Retrieves a list of article translations that are in the Recycle Bin, with pagination support.

  • Read

    Get Trashed KB Categories

    Retrieves a list of KB categories that are in the Recycle Bin, with pagination support.

  • Write

    Restore Trashed Article Translations

    Restores the specified article translations from the Recycle Bin to the help desk portal, including all associated parent entities.

  • Write

    Restore Trashed KB Comments

    Restores the specified KB article translation comments from the Recycle Bin to the help desk portal, including all associated parent entities.

  • Destructive

    Delete Trashed Article Translations

    Permanently deletes the specified article translations from the Recycle Bin, including all associated child entities.

  • Destructive

    Delete Trashed KB Comments

    Permanently deletes the specified KB article translation comments from the Recycle Bin, including all associated child entities.

KBRoot Category

  • Read

    Get root category

    This API fetches the details of a root category.

  • Read

    List root categories

    This API lists a particular number of root categories, based on the limit defined.

  • Read

    Get review owners

    This API fetches review owners of a root category in your helpdesk

  • Read

    Get a category tree

    This API fetches the full tree of a root category in your helpdesk

  • Write

    Create root category

    This API creates a root category (i.e., parent category) in your knowledge base.

  • Write

    Add moderators

    This API adds moderators to a root category in your helpdesk. Note: Moderators act as designated agents within the primary department with access to the Moderation Panel. They are responsible for reviewing and managing comments awaiting approval or flagged as spam.

  • Write

    Add review owner

    This API adds review owners of a root category in your helpdesk

  • Write

    Reorder Root Categories

    Reorders root categories in the knowledge base.

  • Destructive

    Remove review owner

    This API removes review owners of a root category in your helpdesk

  • Destructive

    Remove moderators

    This API removes moderators from a root category in your helpdesk. Note: Moderators act as designated agents within the primary department with access to the Moderation Panel. They are responsible for reviewing and managing comments awaiting approval or flagged as spam.

KBSection

  • Read

    Get a KB section

    This API fetches a section in your helpdesk

  • Write

    Create a KB section

    This API creates a section in your helpdesk

  • Write

    Reorder Sections

    Reorders sections within a parent category.

  • Write

    Update a KB section

    This API updates a section in your helpdesk

Label

  • Read

    List users under a label

    This API lists a particular number of users under a label, based on the limit defined.

  • Read

    List labels

    This API lists a particular number of labels, based on the limit defined.

  • Read

    Get details of label

    This API fetches the details of a particular label.

  • Write

    Create label

    This API creates a label in your help center.

  • Write

    Update label

    This API helps update the details of a label.

  • Write

    Assign label to users

    This API assigns a particular label to multiple users.

  • Destructive

    Delete label

    This API deletes a label from your help center.

  • Destructive

    Remove users under a label

    This API removes all users under a particular label.

Layout

  • Read

    Get Layouts

    This API lists all the layouts configured for a module.

  • Read

    Get Standard Layout Format

    Provides the standard layout format (sections and organization fields) for the given module.

  • Read

    Export PickList Values

    This api behaves as below (i)When Query param fileType=CSV is passed the picklist values gets downloaded in csv file with fieldlabel as its name (ii) When header param is not passed empty 200 response

  • Read

    Get Layout

    This API fetches a layout configured for a module

  • Read

    Get Layout Profiles

    This api returns the profiles associated with a layout

  • Read

    Get My Form

    This API fetches details of a layout, based on the profile of the current user.

  • Write

    Create Layout

    This API creates a new layout. To build the request body, first call getStandardLayoutFormat (GET /api/v1/layouts/standardLayoutFormat with the module) to obtain the sections and fields, then set departmentId, module, layoutName, layoutDisplayName, and isDefaultLayout.

  • Write

    Clone Layout

    This API creates new Layout by cloning existing layout.

  • Write

    Deactivate Layout

    This Api deactivates existing layout

  • Write

    Update Layout

    This API updates details of an existing layout.

  • Write

    Activate Layout

    This api activates the deactivated Layout.

  • Write

    Clone Fields to other Layouts

    This API is to clone a field to other layouts.

  • Write

    Associate Profiles To Layout

    This api Associates the given profiles to the layout

  • Write

    Replace PickList Value

    This API replaces the old value with the new value for the PickList field type in all existing records only. Note : When a value that does not exist in the PickList values is provided as new value, then this API will create the new value without deleting the old one.

  • Write

    Update Layout Field

    This API updates details of a field in the layout.

  • Destructive

    Delete Layout

    This API deletes a layout

  • Destructive

    Remove Field From Layout

    This API is to remove fields from a layout.

Layout Rule Criteria

  • Read

    Get Layout Rule Criteria

    This API lists the fields that can be used in criteria of a specified module in layout rules. Available pre-defined values may contain ${EMPTY}, ${NOTEMPTY}, ${OPEN}, ${CLOSED}, ${CURRENTTIME}. Available types are Text, Date, DateTime, Text, Boolean and Arithmetic.

Layout Rules

  • Read

    Get Layout Rule

    This API fetches a single rule from your help desk layout.

  • Read

    Get Layout Rules

    This API lists all the rules configured for a department/layout.

  • Write

    Update Layout Rule

    This API updates the details of an existing layout rule in a particular layout.

  • Write

    Create Layout Rule

    This API creates a rule for a field in a layout.

  • Destructive

    Delete Layout Rule

    This API deletes a layout rule created for a field from a layout.

License

  • Read

    Get License Feature Details

    Retrieves all available license features in Desk along with their applicability and usage limits for the current portal.

  • Read

    Get License Plan Details

    Retrieves the current portal's license plan information.

Mail Configurations

  • Read

    List department mail configurations

    This API lists the Mail configurations set for a specific department.

  • Read

    List organization mail configurations

    This API lists the Mail configurations set for the entire help desk portal.

  • Write

    Update department mail configurations

    This API updates the Mail configurations set for a specific department.

  • Write

    Update organization mail configurations

    This API updates the Mail configurations set for the entire help desk portal.

  • Destructive

    Update department mail configurations

    This API updates the Mail configurations set for a specific department.

  • Destructive

    Update organization mail configurations

    This API updates the Mail configurations set for the entire help desk portal.

Mail Reply Address

  • Read

    List From addresses

    This API lists the From addresses configured in your help desk portal.

  • Read

    Fetch a single From address

    Retrieves details of a specific From address

  • Write

    Send verification mail

    This API sends a verification link to the From address configured in your help desk portal.

  • Write

    Add a new From address

    This API adds a new From address to the specified department.

  • Write

    Update existing From address

    This API updates an existing From address with the specified data

  • Destructive

    Delete a From address

    This API deletes a From address from your help desk

Module

  • Read

    Get Module

    Retrieves a specific module.

  • Read

    Get Modules Accessible To Current User Profile

    The API fetches a list of modules that are accessible to the current user profile.

  • Read

    Get modules

    The API fetches all the modules available in Zoho Desk. This API is deprecated , use api/v1/organizationModules api for fetching modules.

  • Read

    Get Modules

    Retrieves all modules.

  • Write

    Create Module

    Creates a custom module. Custom modules allow you to organize, store, and manage specific types of data tailored to unique business requirements.

  • Destructive

    Update Module

    Updates a custom module.

New Ticket History

  • Read

    Get Ticket History

    Retrieves details of all actions(called events) performed on a ticket and in the sub-tabs on the ticket detail page, with pagination support.

Organization

  • Read

    Get Organization

    Retrieves the details of an organization from the help desk.

  • Read

    Get Organization Favicon

    Retrieves the favicon set for an organization/portal in the help desk.

  • Read

    Get Organizations

    Retrieves all organizations to which the current user belongs.

  • Read

    Get Accessible Organizations

    Retrieves all organizations which can be accessed using the current OAuth token.

  • Write

    Update Organization

    Updates the details of an organization.

  • Write

    Update Organization Favicon

    Updates the favicon set for an organization/portal in the help desk.

  • Write

    Update Default Organization

    Updates the default organization for the current user in Zoho Desk.

  • Destructive

    Delete Organization Favicon

    Deletes the favicon set for an organization/portal in the help desk.

Pending Approval

  • Read

    Get my pending approvals

    This API lists the pending approvals for a given user

Permalink

  • Read

    Check Topic Permalink Availability

    Checks whether the specified permalink is available for use.

Pinned Conversation

  • Read

    Get pins of a ticket

    This API fetches the list of pins of a particular ticket.

  • Write

    Unpin a ticket's pin

    This API deletes one or more pins from a ticket.

  • Write

    Create a pin on the ticket

    This API creates a new pin on the ticket.

Product Attachment

  • Read

    List all product attachments

    This API lists all attachments in a product.

  • Write

    Create an product attachment

    This API attaches a file to a product.

  • Destructive

    Delete an product attachment

    This API deletes an attachment from a product.

Product

  • Read

    Get Product

    This API fetches a single product from your helpdesk.

  • Read

    Get Products

    This API lists a specific number of products from your help desk portal, based on the limit defined. This API does not support filtering by product name; to find products by name, use the searchProductDuplicates operation.

  • Read

    Search Duplicate Products

    This API searches for duplicate records of a product.

  • Read

    List products by account

    This API lists products associated for a specific account.

  • Read

    List products by contact

    This API lists products associated for a specific contact.

  • Write

    Update Product

    This API updates details of a product in your help desk portal.

  • Write

    Create Product

    This API adds a product to your helpdesk.

  • Write

    Associate Accounts with Product

    This API associates accounts with a product. Only a maximum of 10 accounts can be associated with a product through a single API request.

  • Write

    Associate Contacts with Product

    This API associates contacts with a product. Only a maximum of 10 contacts can be associated with a product through a single API request.

  • Destructive

    Delete Products

    This API moves products to the Recycle Bin of your help desk portal.

Profile

  • Read

    Get My Profile Details

    Retrieves the configuration details and permissions defined for the profile of the currently logged-in user.

  • Read

    Get Profile

    Retrieves details of a specific profile.

  • Read

    Get Profile Count

    Retrieves the number of profiles configured in the help desk portal.

  • Read

    Get Light Agent Profile

    Retrieves the permissions configured for the light agent profile.

  • Read

    Get Profiles

    Retrieves profiles in the help desk portal.

  • Read

    Get My Profile Permissions

    Retrieves the permissions associated with the profile of the currently logged-in user.

  • Read

    Get Agents by Profile

    Retrieves agents mapped to a specific profile.

  • Write

    Update Profile

    Updates the details of an existing profile.

  • Write

    Clone Profile

    Replicates an existing profile.

  • Destructive

    Delete Profile

    Deletes a profile from the help desk portal.

Recent Item

  • Read

    List Recent Items

    This API lists the recent items accessed by the current user.

  • Write

    Mark Recent Item

    This API marks the specified item as a recently accessed item for the current user.

Records

  • Read

    Get Records

    Retrieves a list of records from a custom module, with pagination support.

  • Read

    Get Record

    Retrieves the details of a specific record from a custom module using entityId.

  • Read

    Get Record Count

    Retrieves the total number of records in a specified view of a custom module.

  • Write

    Create Record

    Creates a new record in the specified custom module using field values obtained from the Organization Field API.Prerequisites: Before creating a record, follow this sequence: 1. Call the Organization Field API to retrieve the required field information for the custom module. 2.

  • Write

    Update Record

    Updates an existing record in the specified custom module using field values obtained from the Organization Field API.Prerequisites: Before updating a record, follow this sequence: 1.

  • Write

    Move Records to Recycle Bin

    Moves the specified records of a custom module to the Recycle Bin. Note: Deleted records remain in the Recycle Bin for 60 days, during which they can be restored. After this period, they are permanently deleted.

  • Write

    Update Field in Multiple Records

    Updates a single field value across multiple records in a custom module simultaneously.

  • Destructive

    Delete Record

    Deletes a specific record from a module. Note: If the module supports a Recycle Bin, the record is moved to the Recycle Bin and can be restored within 60 days. If the module does not support a Recycle Bin, the record is permanently deleted and cannot be recovered.

Recyclebin

  • Read

    List deleted resources

    This API lists a particular number of deleted resources, based on the limit specified.

  • Write

    Restore deleted resources

    This API restores the deleted resources specified in the API request. Additionally, the parent resources are also restored.

  • Write

    Restore all resources from Recycle Bin

    This API restores all deleted resources from the Recycle Bin.

  • Destructive

    Delete resources from Recycle Bin

    This API permanently deletes the resources specified in the API request. Additionally, the child resources are also permanently deleted.

  • Destructive

    Delete all resources from Recycle Bin

    This API permanently deletes all resources from the Recycle Bin.

Role

  • Read

    Get Role

    Retrieves details of a specific role.

  • Read

    Get Roles by Role IDs

    Retrieves details of the roles whose IDs are passed in the request.

  • Read

    Get Personal Role

    Retrieves details of the personal role configured in the help desk portal. Note: Agents with the personal role can view only tickets assigned to them and unassigned tickets.

  • Read

    Get Role Count

    Retrieves the number of roles configured in the help desk portal.

  • Read

    Get Agents by Role

    Retrieves agents mapped to a specific role.

  • Read

    Get Roles

    Retrieves roles in the help desk portal, with pagination support.

  • Write

    Update Role

    Updates details of an existing role.

  • Write

    Create Role

    Creates a role in the help desk portal.

  • Destructive

    Delete Role

    Deletes a role from the help desk portal.

Routing Preference

  • Read

    Get Routing Preferences

    Retrieves the routing preferences for the specified department.

  • Write

    Update Routing Preferences

    Updates the routing preferences for a department.

Rule Group Execution Log

  • Read

    Get Execution Logs

    Retrieves a list of async rule group execution logs, with pagination support.

  • Read

    Get Execution Log

    Retrieves the details of a specific execution log entry. The response includes execution metadata and a rule group snapshot with per-node execution details.

Rule Group

  • Read

    Get All RuleGroups

    This API returns a list of all rule groups configured for a specific engine.

  • Write

    Create RuleGroup

    This API creates a new RuleGroup.

  • Write

    Update RuleGroup Status

    This API updates the status of a rule group to either active or inactive for the specified department.

  • Destructive

    Update RuleGroup

    This API updates the rulegroup

Saml

  • Read

    Get Saml Config Meta Data

    GET /api/web/helpCenter/{helpCenterId}/samlConfigMetaData

Search

  • Read

    Search Tickets

    This API searches for tickets in your help desk. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Records

    This API searches for records in your help desk. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Calls

    This API searches for the calls in your help desk portal. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Accounts

    This API searches for accounts in your help desk. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Articles

    This API searches for help articles in your help desk. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Products

    This API searches for the products in your help desk portal. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Contacts

    This API searches for contacts in your help desk. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Activities

    This API searches for the activities in your help desk portal. You can provide comma-separated values, which will perform the search on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search across modules

    This API returns information from all modules or a specific module, based on the value of the module query param.

  • Read

    Search Tasks

    This API searches for tasks in your help desk. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search Events

    This API searches for the events in your help desk portal. You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. Learn more about search and how it works.

  • Read

    Search solutions

    Searches solutions.

Sharing Rule

  • Read

    Get Data Sharing Rules

    Retrieves the data sharing rules configured in the help desk portal. Note: These rules control user permissions to view or edit resources across modules in Zoho Desk.

  • Write

    Update Data Sharing Rules

    Updates the data sharing rules configured in the help desk portal. Note: These rules control user permissions to view or edit resources across modules in Zoho Desk.

Skill Configuration

  • Read

    Get Skill Configuration

    Retrieves the skill configuration for the specified department.

  • Write

    Update Skill Configuration

    Updates the skill configuration for a department.

Skill

  • Read

    Get Skills

    Retrieves a list of skills in a department, with pagination support.

  • Read

    Get Skill

    Retrieves details of a specific skill.

  • Read

    Get Criteria Fields for Skill in a Department

    Retrieves fields supported in criteria for skills by module.

  • Read

    List Associated Automation Rules

    Retrieves automation rules that include the specified skill, with pagination support.

  • Read

    Get Skills of an Agent

    Retrieves skills mapped with the specified agent by department.

  • Write

    Create Skill

    Creates a new skill.

  • Write

    Reorder Skills in a Department

    Reorders skills in a department.

  • Write

    Execute Skill Based Ticket Assignment

    Assigns tickets to agents based on skills and routing configuration.

  • Write

    Update Skill

    Updates an existing skill.

  • Write

    Map Skills in a Department with an Agent

    Modifies skills mapped for an agent in a department.

  • Write

    Recalculate Ticket Skills

    Re-evaluates and updates the skills associated with a ticket based on the ticket's current details and skill configuration.

  • Destructive

    Delete skill

    This API deletes a skill from your help desk portal

Skill Type

  • Read

    Get Skill Types

    Retrieves a list of skill types in a department, with pagination support.

  • Read

    Get Skill Type

    Retrieves details of a specific skill type.

  • Write

    Create Skill Type

    Creates a new skill type.

  • Write

    Update Skill Type

    Updates an existing skill type.

  • Destructive

    Delete a Skill Type

    This API Deletes a Skill Type

Starred View

  • Read

    Get Starred Views

    This API lists the starred views in a module. Number of resources in the starred view is displayed only for the Tickets module.

  • Write

    Add Star View

    This API stars a view, enabling quick access to the view.

  • Destructive

    Remove Star View

    This API unstars a view, disabling quick access to the view.

  • Destructive

    Reorder Starred Views

    This API helps reorder the starred views in a module.

Subject Access Request

  • Read

    Export all subject data from Zoho Desk

    This API exports data related to the subject, from your Zoho Desk portal.

  • Read

    Get fields and conditions

    This API fetches the available filter fields and their supported conditions for the specified module.

  • Read

    Get subject access request

    This API fetches the details of a particular SAR.

  • Read

    List subject access requests

    This API lists a particular number of subject access requests, based on the limit specified.

  • Read

    Export specific resources

    This API exports specific resources related to a subject access request.

  • Read

    Get count of resources related to request

    This API returns the number of resources related to a subject access request.

  • Destructive

    Erase all subject data from Zoho Desk

    This API erases data related to the subject, from your Zoho Desk portal.

    POST /api/v1/subjectAccessRequests/eraseAll

  • Destructive

    Erase specific resources

    This API erases specific resources related to a subject access request.

    POST /api/v1/subjectAccessRequests/erase

Support Email Domain

  • Read

    Get Support email address domain

    This API fetches the domain of the support email address.

  • Destructive

    Update Support email address domain

    This API updates the domain (the "~mycompany~" part) of the support email address.!!1. Only the primary contact of the organization can update the domain of the support email address.!2. The new support email address will be support@zylker.com.!3.

Support Plan

  • Read

    Get Support Plan

    Retrieves details of a specific support plan

  • Read

    Get Support Plans

    Retrieves support plans for the specified department, with pagination support

  • Write

    Update Support Plan

    Updates a support plan

  • Write

    Create Support Plan

    Creates a support plan

  • Destructive

    Delete Support Plan

    This API deletes a support plan.

Task Attachment

  • Read

    List Task attachments

    This API lists the files attached to a task.

  • Read

    Retrieve task attachment content

    Retrieve the content of an attachment associated with the specified task.

    GET /api/v1/tasks/{taskId}/attachments/{attachmentId}/content

  • Write

    Create Task attachment

    This API attaches a file to a task

  • Destructive

    Delete Task attachment

    This API removes an attachment from a task.

Task Comments

  • Read

    Get a task comment

    This API fetches a task comment from the portal.

  • Read

    List all task comments

    This API lists a particular number of comments recorded on a task, based on the limit specified.

  • Write

    Create a task comment

    This API adds a comment to a task.

  • Destructive

    Update a task comment

    This API updates an existing task comment.

Task

  • Read

    Get task

    This API fetches a task from your help desk portal.

  • Read

    List tasks

    This API fetches a particular number of tasks, based on the limit specified.

  • Read

    List tasks by ticket

    This API lists all tasks associated with a particular ticket.

  • Read

    List all tasks count

    This API returns the number of tasks in your help desk.

  • Write

    Update many tasks

    This API updates multiple tasks at once.

  • Write

    Update a task

    This API helps update the details of a task.

  • Write

    Empty spam tasks

    This API deletes all spam tasks.

  • Write

    Create task

    This API creates a task in your help desk portal.

  • Destructive

    Delete spam tasks

    This API deletes the given spam tasks

  • Destructive

    Delete tasks

    This API moves task entries to the Recycle Bin of your help desk portal.

Task Time Entry

  • Read

    List Task Time Entries

    This API lists the time entries associated with a task.

  • Read

    Get summation of Task Time Entries

    This API fetches the sum of time entries associated with a task.

  • Read

    Get a Task Time Entry

    This API fetches a time entry recorded for a task.

  • Write

    Add a Task Time Entry

    This API creates a time entry in your help desk

  • Write

    Update a Task Time Entry

    This API updates details of an existing time entry.

Task Timer

  • Read

    Get Task Timer

    This API fetches the time elapsed in the task timer, along with the current state

  • Read

    List task timers

    This API fetches the details of timers currently active in a task.

  • Write

    Performs Task Timer actions

    This API performs timer-related actions, such as START, STOP, PAUSE and RESUME

Team

  • Read

    Get Teams in Department

    Retrieves details of all teams in a specific department, with pagination support.

  • Read

    Get Teams from All Associated Departments

    Retrieves details of all teams created in all departments to which the current user belongs, with pagination support.

  • Read

    Get Associable Teams

    Retrieves teams that can be added as sub-teams to the specified team.

  • Read

    Get Teams for a Role

    Retrieves details of all teams associated with a specific role, with pagination support.

  • Read

    Get Teams of an Agent

    Retrieves details of all teams to which an agent belongs, with pagination support.

  • Read

    Get Team Members

    Retrieves details of all members of a specific team.

  • Read

    Get Team

    Retrieves details of a specific team.

  • Write

    Create Team

    Creates a team in the help desk portal.

  • Write

    Update Team

    Updates details of an existing team.

  • Destructive

    Delete Team

    Deletes an existing team from the help desk portal. Note: To reassign the open and on hold tickets and tasks of the deleted team to a different team, pass ticketNewTeam, taskNewTeam, ticketNewAgent, and taskNewAgent in the request. If you do not want

Template Folders

  • Read

    Get Template Folders

    Retrieves a list of template folders for the specified department, with pagination support.

  • Read

    Get Template Folder

    Retrieves details of a specific template folder.

  • Write

    Create Template Folder

    Creates a new template folder.

  • Write

    Update Template Folder

    Updates an existing template folder.

  • Destructive

    Update Template Folder

    Updates an existing template folder.

  • Destructive

    Delete Template Folder

    Delete a Template Folder

Thread

  • Read

    Get Original Mail Content

    This API get the orginal mail content including mail headers

  • Read

    List all threads

    This API lists all threads in your helpdesk.

  • Read

    Get Latest thread

    This API fetches the most recent thread of a ticket. Note: The API response for 'Get Latest Thread' will be dynamic, based on the channel from which the latest thread is received.

  • Read

    Get full thread content

    This API fetches the full content of a thread.

  • Read

    Get a thread

    This API fetches a single thread from your help desk portal.

  • Read

    List conversations of a ticket

    This API lists a particular number of threads and comments recorded on a ticket, based on the limit specified.

  • Read

    Retrieve thread attachment content

    Retrieve the content of an attachment associated with the specified ticket thread.

    GET /api/v1/tickets/{ticketId}/threads/{threadId}/attachments/{attachmentId}/content

  • Write

    Update Draft

    This API updates a draft thread created via the @EMAIL@, @FACEBOOK@, or @FORUM@ channel.

  • Write

    Send Email Reply

    This API sends an email reply. The from address in the email must be a from address configured in your help desk portal.

  • Write

    Draft Email Reply

    This API drafts an email reply. The from address in the email must be a from address configured in your help desk portal.

  • Write

    Resend failed thread

    This API resends a failed outgoing thread.

  • Write

    Send Draft

    This API sends a draft thread from your help desk portal.

  • Write

    Send For Review

    This API saves drafts of agent's responses to customers and sends them to a manager/senior agent for review.

  • Destructive

    Delete Draft

    This API deletes a draft thread from a ticket.

  • Destructive

    Delete attachment

    This API deletes an attachment from a draft thread.

Ticket Approvals

  • Read

    List approvals

    This API lists the approvals submitted in your help desk.

  • Read

    Get approval

    This API fetches the details of an approval.

  • Write

    Create approval

    This API creates an approval in your help desk.

  • Write

    Update approval

    This API updates the details of an existing ticket approval.

Ticket Attachment

  • Read

    List ticket attachments

    This API lists the files attached to a ticket.

  • Write

    Create Ticket attachment

    This API attaches a file to a ticket.

  • Write

    Update Ticket attachment

    This API updates an existing attachment.

  • Destructive

    Delete Ticket attachment

    This API deletes an attachment from a ticket.

Ticket Comment

  • Read

    Get a ticket comment history

    This API fetches the history of comments recorded on a ticket, including instances of adding and editing the comments.

  • Read

    Get ticket comment

    This API fetches a ticket comment from your help desk portal.

  • Read

    List all ticket comments

    This API lists a particular number of comments recorded on a ticket, based on the limit specified.

  • Write

    Update ticket comment

    This API modifies an existing comment. To include an @mention, follow this format: zsu[@user:{zuid}]zsu.

  • Write

    Create ticket comment

    This API adds a comment to a ticket. To include an @mention, follow this format: zsu[@user:{zuid}]zsu.

  • Destructive

    Delete ticket comment

    This API deletes a comment.

Ticket Count

  • Read

    Get tickets count

    This API returns the ticket count of your help desk.

  • Read

    Get ticket count by field

    This API returns the ticket count of your help desk, filtered by a specific field.

Ticket Followers

  • Read

    Get ticket followers

    This API fetches the list of users following a ticket. Note: Sometimes, followers of a contact/account indirectly end up as ticket followers if the ticket is associated with the contact/account they follow.

  • Write

    Add ticket followers

    This API adds one or more users to the followers list of a ticket.

  • Destructive

    Remove ticket followers

    This API removes one or more users from the followers list of a ticket.

Ticket

  • Read

    Get Ticket Resolution

    Retrieves the resolution notes of a ticket.

  • Read

    Get Agents Tickets Count

    Retrieve the number of tickets assigned to one or more agents from the specified department.

  • Read

    Get Agent-followed Tickets

    Retrieves tickets that are followed by agents, with pagination support.

  • Read

    Get Archived Tickets

    Retrieves archived tickets from the specified department based on the selected view type, with pagination support.

  • Read

    Get Ticket Metrics

    Retrieves detailed metrics of a ticket, including response times, resolution time, agent handling details, and ticket-related counts.

  • Read

    Get Ticket Resolution History

    Fetches the resolution history of a ticket.

  • Read

    List tickets by contact

    This API lists tickets received from a specific contact.

  • Read

    Get Tickets

    Retrieves a list of tickets, with pagination support.

  • Read

    List all ticketQueueView count

    This API returns the number of tickets in a particular view.

  • Read

    Get Ticket

    Retrieves a specific ticket and its associated details based on the provided ticket ID.

  • Read

    List tickets by products

    This API lists tickets received from a specific products.

  • Write

    Update Ticket Resolution

    Updates the resolution notes of a ticket.

  • Write

    Update Field in Multiple Tickets

    Updates a single field value across multiple tickets simultaneously.

  • Write

    Move Ticket

    Moves a ticket from one department to another department.

  • Write

    Merge Tickets

    Merges multiple tickets into a single ticket. Note: A maximum of 5 tickets can be merged at a time.

  • Write

    Map articles to tickets

    This API maps tickets with help articles to automatically suggest the same articles for similar tickets that arrive later.

  • Write

    Mark Tickets as Spam

    Marks or unmarks tickets as spam based on the isSpam parameter.

  • Write

    Mark Ticket as Read

    Marks a ticket as read by the user.

  • Write

    Create Ticket

    Creates a new ticket using the data provided in the request payload.

  • Write

    Close Tickets

    Closes the specified tickets.

  • Write

    Update Ticket

    Updates an existing ticket using the data provided in the request payload.

  • Write

    Mark Ticket as Unread

    Marks a ticket as unread by the user.

  • Write

    Split Tickets

    Creates a new ticket by splitting a single thread from an existing ticket. Note: Only the selected thread is converted into a new ticket. Any subsequent threads in the original ticket are not included in the new ticket.

  • Destructive

    Delete Ticket Resolution

    Deletes the resolution notes of a ticket.

  • Destructive

    Delete Tickets

    Moves the specified tickets to the Recycle Bin. Note: Deleted tickets remain in the Recycle Bin for 60 days, during which they can be restored. After this period, they are permanently deleted.

  • Destructive

    Delete Spam Tickets

    Deletes the specified spam tickets. Note: Deleted tickets cannot be restored from the Recycle Bin.

  • Destructive

    Delete All Spam Tickets

    Deletes all spam tickets in the specified department. Note: Deleted tickets cannot be restored from the Recycle Bin.

Ticket Tag

  • Read

    Get Tags in a Ticket

    Retrieves tags associated with the specified ticket.

  • Read

    Get Recent Tags

    Retrieves the five most recent tags associated with tickets for the specified department.

  • Read

    Get Ticket Tags

    Retrieves ticket tags in the help desk portal for the specified department, with pagination support.

  • Read

    Search Tags

    Searches for tags in the help desk portal for the specified department, with pagination support.

  • Read

    Get Tickets by Tag

    Retrieves tickets associated with a specific tag, with pagination support.

  • Write

    Dissociate Tag

    Removes one or more tags from a ticket.

  • Write

    Update Recent Tags

    Adds a tag to the list of recently viewed tags.

  • Write

    Replace Tag

    Replaces an existing tag with another specified tag.

  • Write

    Associate Tag

    Adds one or more tags to a ticket.

Ticket Template

  • Read

    Get ticket template

    This API fetches the details of a particular ticket template.

  • Read

    List ticket templates

    This API lists a particular number of ticket templates, based on the limit specified.

  • Write

    Update ticket template

    This API helps update the details of a particular ticket template.

  • Write

    Create ticket template

    This API helps create a ticket template in your help desk portal.

  • Destructive

    Delete ticket template

    This API deletes a ticket template from your help desk portal.

Ticket Time Entry

  • Read

    Get Ticket Time Entry

    This API fetches a time entry recorded for a ticket.

  • Read

    List Ticket Time Entries

    This API lists the time entries associated with a ticket.

  • Read

    Get summation of Ticket Time Entries

    This API fetches the sum of time entries associated with a ticket.

  • Read

    Get Ticket Time Entries by Billing Type

    This API fetches time entries for a ticket created after recently modified time of the given billing type from your help desk

  • Write

    Add Ticket Time Entry

    This API adds a time entry in your help desk

  • Destructive

    Delete Ticket Time Entry

    This API deletes a time entry recorded for a ticket

  • Destructive

    Update Ticket Time Entry

    This API updates an existing ticket time entry

Ticket Timer

  • Read

    List active timers

    This API lists a particular number of currently active timers in a department, based on the limit specified.

  • Read

    Get Ticket Timer

    This API fetches the time elapsed in the ticket timer, along with the current state

  • Read

    Get Active Timer for an Agent

    This API fetches currently running timer details for an agent

  • Read

    List ticket timers

    This API fetches the details of timers currently active in a ticket.

  • Write

    Performs Ticket Timer actions

    This API performs timer-related actions, such as START, STOP, PAUSE and RESUME

Time Tracking

  • Read

    Get TimeTrack Settings

    This API fetches the details of the TimeTrack Settings configured in your helpdesk.

  • Read

    List history details of billing TimeTrack Settings

    This API fetches the history of changes made to the billing preferences in time tracking settings.

  • Write

    Create TimeTrackSettings

    This API adds a TimeTracking configuration to your helpdesk.

  • Destructive

    Update TimeTrackSettings

    This API updates an existing TimeTracking configuration.

Upload

  • Write

    Upload file

    This API uploads a file to the zoho desk service as a temporary attachment.

User

  • Read

    Get User Details

    This API fetches the details of a particular help center user.

  • Read

    Get User Labels

    This API lists a particular number of labels associated with a user, based on the limit defined.

  • Read

    Get Users

    This API lists a particular number of help center users, based on the limit defined. It also helps you search for specific users.

  • Read

    Get User Groups

    This API lists a particular number of user groups in a help center, based on the limit defined.

  • Write

    Update User Details

    This API helps update the details of a particular help center user.

  • Write

    Associate Groups To Users

    This API adds a user to the groups specified.

  • Write

    Assign Labels To User

    This API assigns the labels you specify to a particular user.

  • Destructive

    Remove Labels From User

    This API removes the labels you specify from a particular user.

  • Destructive

    Delete Groups From Users

    This API removes a user from the groups specified.

  • Destructive

    Delete End User

    This API permanently deletes all identifying information about a user from your help center.

  • Destructive

    Remove Portal User

    Removes a portal user from the help center.

Validation Rule Criteria

  • Read

    Get Validation Rule Criteria

    This API lists the fields that can be used in criteria of a specified module in validation rules. Available pre-defined values may contain ${EMPTY}, ${NOTEMPTY}, ${OPEN}, ${CLOSED}, ${CURRENTTIME}. Available types are Text, Date, DateTime, Text, Boolean and Arithmetic.

Validation Rules

  • Read

    Get Validation Rule

    This API fetches a validation rule configured for your layout.

  • Read

    Get Validation Rules

    This API fetches all the validation rules configured for your department/layout.

  • Write

    Update Validation Rule

    This API updates the details of an existing validation rule in a particular layout.

  • Write

    Create Validation Rule

    This API creates a validation rule for a field in a layout.

  • Destructive

    Delete Validation Rule

    This API deletes a validation rule created for a field from a layout.

Webhook

  • Read

    Get Webhooks

    This API lists all webhooks configured in your help desk.

  • Read

    Get webhook

    This API fetches a single webhook from your help desk.

  • Write

    Create webhook

    This API creates a webhook in your help desk. When the API is invoked, a validation GET request is sent to the subscription URL. That subscription end-point must return a 200 OK message to confirm the subscription.

  • Write

    Update Webhook

    This API updates the details of an existing webhook. When the webhook's URL is altered, a validation GET request is sent to the new URL. If the 200 OK message is not received, a validation POST request is initiated.

  • Destructive

    Delete Webhook

    This API deletes an existing webhook. After this API is executed, the URL in the webhook stops receiving event information.

See How connections work for access and permissions, or browse all integrations.