> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho Desk

> How to set up the Zoho Desk connector, plus the actions and events that are available.

![Zoho Desk](https://stackone-logos.com/api/zoho-desk/filled/svg)

v3.2.0[See changelog](https://docs.stackone.com/connectors/zoho-desk/changelog.md)

[45 actions](#actions) · [20 events](#events) · 1 auth method

Customer Support
Ticketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/zoho-desk/guides/connector-profile/oauth-2-0.md)
>
> Requires registering a server-based application in the Zoho API Console. Access is limited to what the authorizing Zoho...

Optionally, configure receiving Events for Zoho Desk into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/zoho-desk/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/zoho-desk/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

Desk.automations.DELETE

Desk.basic.CREATE

Desk.basic.READ

Desk.basic.UPDATE

Desk.contacts.CREATE

Desk.contacts.DELETE

Desk.contacts.READ

Desk.contacts.UPDATE

Desk.search.READ

Desk.settings.CREATE

Desk.settings.READ

Desk.settings.UPDATE

Desk.tickets.CREATE

Desk.tickets.DELETE

Desk.tickets.READ

Desk.tickets.UPDATE

Desk.webhooks.CREATE

Desk.webhooks.DELETE

Desk.webhooks.READ

Desk.webhooks.UPDATE

No scopes found

45 actions

ActionDescriptionRequired scopes

List Accounts`zoho-desk_list_accounts`

Retrieve a paginated list of accounts from Zoho Desk. Returns account information including name, industry, and contact...

`Desk.contacts.READ`

Get Account`zoho-desk_get_account`

Retrieve detailed information about a specific account by its ID. Returns complete account data including name, industry...

`Desk.contacts.READ`

Create Account`zoho-desk_create_account`

Create a new account in Zoho Desk. Requires accountName at minimum.

`Desk.contacts.CREATE`

Update Account`zoho-desk_update_account`

Update an existing account in Zoho Desk. All fields are optional - only provided fields will be updated.

`Desk.contacts.UPDATE`

Delete Accounts`zoho-desk_delete_accounts`

Move specified accounts to the Recycle Bin in Zoho Desk. Supports bulk deletion by providing multiple account IDs.

`Desk.contacts.DELETE`

List Agents`zoho-desk_list_agents`

Retrieve a paginated list of agents from Zoho Desk. Returns agent information including name, email, status, and role as...

`Desk.settings.READ``Desk.basic.READ`

Get Agent`zoho-desk_get_agent`

Retrieve detailed information about a specific agent by their ID. Returns complete agent data including profile, role, a...

`Desk.settings.READ``Desk.basic.READ`

Add Agent`zoho-desk_add_agent`

Add a new agent to your Zoho Desk help desk. Requires email, last name, department associations, and role permission typ...

`Desk.settings.CREATE``Desk.basic.CREATE`

Update Agent`zoho-desk_update_agent`

Update an existing agent's details in Zoho Desk. All fields are optional - only provided fields will be updated.

`Desk.settings.UPDATE``Desk.basic.UPDATE`

List Contacts`zoho-desk_list_contacts`

Retrieve a paginated list of contacts from Zoho Desk. Returns contact information including name, email, phone, and acco...

`Desk.contacts.READ`

Get Contact`zoho-desk_get_contact`

Retrieve detailed information about a specific contact by its ID. Returns complete contact data including name, email, p...

`Desk.contacts.READ`

Create Contact`zoho-desk_create_contact`

Create a new contact in Zoho Desk. Requires lastName at minimum.

`Desk.contacts.CREATE`

Update Contact`zoho-desk_update_contact`

Update an existing contact in Zoho Desk. All fields are optional - only provided fields will be updated.

`Desk.contacts.UPDATE`

Delete Contacts`zoho-desk_delete_contacts`

Move one or more contacts to the Recycle Bin. Contacts can be restored from trash if needed.

`Desk.contacts.DELETE`

List Tickets By Contact`zoho-desk_list_tickets_by_contact`

Retrieve a paginated list of tickets received from a specific contact. Returns ticket information filtered by contact.

`Desk.search.READ``Desk.tickets.READ``Desk.contacts.READ`

List Departments`zoho-desk_list_departments`

Retrieve a paginated list of departments from Zoho Desk. Returns department information including name, description, and...

`Desk.settings.READ``Desk.basic.READ`

Get Department`zoho-desk_get_department`

Retrieve detailed information about a specific department by its ID. Returns complete department data including name, de...

`Desk.settings.READ``Desk.basic.READ`

Add Department`zoho-desk_add_department`

Add a new department to your Zoho Desk help desk portal. Requires name and at least one associated agent.

`Desk.settings.CREATE``Desk.basic.CREATE`

Update Department`zoho-desk_update_department`

Update an existing department in Zoho Desk. All fields are optional - only provided fields will be updated.

`Desk.settings.UPDATE``Desk.basic.UPDATE`

Enable Department`zoho-desk_enable_department`

Enable a previously disabled department in Zoho Desk.

`Desk.settings.UPDATE``Desk.basic.UPDATE`

Disable Department`zoho-desk_disable_department`

Disable a department in Zoho Desk. Moves agents to another department and optionally moves emails.

`Desk.settings.UPDATE``Desk.basic.UPDATE`

List Organizations`zoho-desk_list_organizations`

Retrieve a list of all organizations (portals) accessible to the authenticated user. Returns organization details includ...

`Desk.settings.READ``Desk.basic.READ`

Get Organization`zoho-desk_get_organization`

Retrieve detailed information about a specific organization by its ID. Returns organization settings, configuration, and...

`Desk.settings.READ``Desk.basic.READ`

List Skills`zoho-desk_list_skills`

Retrieve a paginated list of skills from a department in Zoho Desk. Returns skill information including name, status, an...

`Desk.settings.READ`

Get Skill`zoho-desk_get_skill`

Retrieve detailed information about a specific skill by its ID. Returns complete skill data including name, description,...

`Desk.settings.READ`

Create Skill`zoho-desk_create_skill`

Create a new skill in Zoho Desk. Requires name, status, skillTypeId, and criteria (including pattern).

`Desk.settings.CREATE`

Update Skill`zoho-desk_update_skill`

Update an existing skill in Zoho Desk. All fields are optional - only provided fields will be updated.

`Desk.settings.UPDATE`

Delete Skill`zoho-desk_delete_skill`

Delete a specific skill from Zoho Desk by its ID. Returns 204 on success with no response body.

`Desk.automations.DELETE`

List Skill Types`zoho-desk_list_skill_types`

Retrieve a paginated list of skill types from Zoho Desk. Skill types enable categorization of different competency class...

`Desk.settings.READ`

Get Skill Type`zoho-desk_get_skill_type`

Retrieve detailed information about a specific skill type by its ID.

`Desk.settings.READ`

Create Skill Type`zoho-desk_create_skill_type`

Create a new skill type in Zoho Desk. Requires name and departmentId.

`Desk.settings.CREATE`

Update Skill Type`zoho-desk_update_skill_type`

Update an existing skill type in Zoho Desk. Only name can be updated.

`Desk.settings.UPDATE`

Delete Skill Type`zoho-desk_delete_skill_type`

Delete a specific skill type from Zoho Desk by its ID. Returns 204 on success with no response body.

`Desk.automations.DELETE`

List Tickets`zoho-desk_list_tickets`

Retrieve a paginated list of all tickets from Zoho Desk. Returns ticket information including subject, status, priority,...

`Desk.tickets.READ`

Get Ticket`zoho-desk_get_ticket`

Retrieve detailed information about a specific ticket by its ID. Returns complete ticket data including subject, status,...

`Desk.tickets.READ`

List All Associated Tickets`zoho-desk_list_all_associated_tickets`

Retrieve a paginated list of tickets associated with you from the help desk. Returns tickets based on filters like depar...

`Desk.tickets.READ`

Create Ticket`zoho-desk_create_ticket`

Create a new support ticket in Zoho Desk. Requires subject and departmentId at minimum.

`Desk.tickets.CREATE`

Update Ticket`zoho-desk_update_ticket`

Update an existing ticket in Zoho Desk. All fields are optional - only provided fields will be updated.

`Desk.tickets.UPDATE`

Move Tickets To Trash`zoho-desk_move_tickets_to_trash`

Move one or more tickets to the Recycle Bin. Tickets can be restored from trash if needed.

`Desk.tickets.DELETE`

Move Ticket`zoho-desk_move_ticket`

Move a ticket from one department to another. Can also move forum tickets to a different community sub-category.

`Desk.tickets.UPDATE`

List Webhooks`zoho-desk_list_webhooks`

Lists all webhooks configured in the help desk.

`Desk.webhooks.READ`

Get Webhook`zoho-desk_get_webhook`

Retrieves a single webhook by ID.

`Desk.webhooks.READ`

Create Webhook`zoho-desk_create_webhook`

Creates a new webhook subscription in the help desk.

`Desk.webhooks.CREATE`

Update Webhook`zoho-desk_update_webhook`

Updates an existing webhook subscription.

`Desk.webhooks.UPDATE`

Delete Webhook`zoho-desk_delete_webhook`

Deletes an existing webhook subscription.

`Desk.webhooks.DELETE`

## Events

Tags

Select all
|
Clear

Accounts

Agents

Contacts

Departments

Tickets

Verification

Webhooks

No tags found

20 events

EventDescriptionTags

Active Check`zoho-desk_webhook_active_check`

Answers Zoho Desk's callback URL validation request, sent when a webhook is created or its URL changes, and emits it as...

Verification

Ticket Created`zoho-desk_webhook_ticket_created`

Processes inbound Zoho Desk ticket creation events.

TicketsWebhooks

Ticket Updated`zoho-desk_webhook_ticket_updated`

Processes inbound Zoho Desk ticket update events.

TicketsWebhooks

Ticket Deleted`zoho-desk_webhook_ticket_deleted`

Processes inbound Zoho Desk ticket deletion events.

TicketsWebhooks

Ticket Comment Added`zoho-desk_webhook_ticket_comment_added`

Processes inbound Zoho Desk ticket comment creation events.

TicketsWebhooks

Ticket Comment Updated`zoho-desk_webhook_ticket_comment_updated`

Processes inbound Zoho Desk ticket comment update events.

TicketsWebhooks

Ticket Thread Added`zoho-desk_webhook_ticket_thread_added`

Processes inbound Zoho Desk ticket thread creation events.

TicketsWebhooks

Ticket Attachment Added`zoho-desk_webhook_ticket_attachment_added`

Processes inbound Zoho Desk ticket attachment creation events.

TicketsWebhooks

Ticket Attachment Deleted`zoho-desk_webhook_ticket_attachment_deleted`

Processes inbound Zoho Desk ticket attachment deletion events.

TicketsWebhooks

Contact Created`zoho-desk_webhook_contact_created`

Processes inbound Zoho Desk contact creation events.

ContactsWebhooks

Contact Updated`zoho-desk_webhook_contact_updated`

Processes inbound Zoho Desk contact update events.

ContactsWebhooks

Contact Deleted`zoho-desk_webhook_contact_deleted`

Processes inbound Zoho Desk contact deletion events.

ContactsWebhooks

Account Created`zoho-desk_webhook_account_created`

Processes inbound Zoho Desk account creation events.

AccountsWebhooks

Account Updated`zoho-desk_webhook_account_updated`

Processes inbound Zoho Desk account update events.

AccountsWebhooks

Account Deleted`zoho-desk_webhook_account_deleted`

Processes inbound Zoho Desk account deletion events.

AccountsWebhooks

Department Created`zoho-desk_webhook_department_created`

Processes inbound Zoho Desk department creation events.

DepartmentsWebhooks

Department Updated`zoho-desk_webhook_department_updated`

Processes inbound Zoho Desk department update events.

DepartmentsWebhooks

Agent Created`zoho-desk_webhook_agent_created`

Processes inbound Zoho Desk agent creation events.

AgentsWebhooks

Agent Updated`zoho-desk_webhook_agent_updated`

Processes inbound Zoho Desk agent update events.

AgentsWebhooks

Agent Deleted`zoho-desk_webhook_agent_deleted`

Processes inbound Zoho Desk agent deletion events.

AgentsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.