Zoho Cliq MCP Tools
The Zoho MCP server provides various tools for interacting with Zoho Cliq. The table below lists the available tools, along with their descriptions and everyday use cases.
The following Cliq modules are supported with Zoho MCP. Locate the relevant module here for easy navigation of the available tools along with its purpose.
- Messages
- Chats
- Scheduled Messages
- Threads
- Channels
- Reminders
- Roles
- Designations
- Teams
- Departments
- Users
- User fields
- User status
- Bots
- Databases
- Map Tickers
- Files
- Calls and Meetings
- Events
- Remote work
- Bulk Export
- Custom Domain
- Custom Email
| Module | Tool | Description |
| Messages | Get Messages | Retrieves messages from a chat conversation that the user has access to |
| Retrieve a message | Use this to retrieve a message from a chat conversation that you have access to | |
| Post message in a channel | To post a message in a channel using its unique name. | |
| Post message to a bot | Send a message to a bot using its unique name. | |
| Post message in chat | To post a message in a chat (or thread) | |
| Post message to a user | Post a message to a user by giving the email address in the request URL, followed by the message object containing plain text or message card | |
| Edit a message | Use this to edit a message in a conversation | |
| Delete a message | Use this to delete a message in a conversation | |
| Get Reactions | Use this API to retrieve details for all reactions to a specific message. | |
| Add a reaction | Use this API to add a react to a message sent in a chat | |
| Delete a reaction | Use this API to delete the reaction to a message. | |
| Chats | Retrieve all direct chats | Use this API to get details of all direct chats. |
Retrieve the members of a chat | Use this API to get details of members of a chat. | |
Mute a chat | Use this API to mute a chat conversation. | |
Unmute a chat | Use this API to unmute a chat conversation. | |
Pin a message | Use this API to pin a message within a conversation. | |
Retrieve a pinned message | Use this API to retrieve a pinned message within a conversation. | |
Unpin a message | Use this API to unpin a message in a conversation. | |
Leave a group chat | Use this API to exit a group chat. | |
| Threads | Create and send a thread message | Use this API to create a thread from a message sent in a channel. |
Send a message to an existing thread | Use this API to send a message to an existing thread | |
Get threads of a channel | Use this API to retrieve all the threads in a chat. | |
Auto follow a thread | Use this API to auto-follow all threads created in a channel. | |
Get thread followers | Use this API to get the followers of the thread. | |
Add followers to a thread | Use this API to add one or more users as followers to an existing thread. | |
Remove followers from a thread | Removes one or more specified users from the followers list of a given thread. | |
Get non-followers of a thread | Use this API to retrieve the list of channel members who are not currently following the specified thread. | |
Join and follow a thread | Allows the authenticated user to join a thread as a follower | |
Leave and unfollow a thread | Allows the authenticated user to leave a thread they are currently following. | |
Update the state of a thread | Use this API to close or reopen a thread. This can be performed by a user or by a bot. | |
Get main message of a thread | Use this API to retrieve the main message from which the thread was created. | |
| Channels | Create a channel | Use this API to create a new channel in Cliq. |
List all channels | Retrieve a list of channels based on the given filters | |
Retrieve channel information | Use this API to get details of a specific channel. | |
Update a channel | Use this API to update a specific channel | |
Delete a channel | Use this API to delete an existing channel. | |
Get Channel Members | Use this API to get the list of all members in a channel. | |
Add Channel Members | Use this API to add members in a channel, by giving their user id or their email ID | |
Delete Channel Members | Use this API to delete groups of members from the channel | |
Add a Bot to a Channel | Use this API to add a bot to a channel by providing its unique name | |
Update role of a channel member | Use this API to add a bot to a channel by providing its unique name | |
Approve a Channel | Organization admins can use this API to approve a newly created organization level channel | |
Reject a Channel | Organization admins can use this API to reject a newly created organization level channel | |
Join a Channel | Use this API to join a channel | |
Leave a Channel | Use this API to leave a channel | |
Archive a Channel | Use this API to archive a channel | |
| Reminders | Create a reminder | Create and assign reminders to yourself, your teammate, or your colleague. You can also assign reminders to a chat or a channel, or set a message in chat as a reminder. Each reminder type comes with its own set of necessary parameters to be passed in the request body. |
Get the list of all reminders | Use this API to retrieve details for all reminders. If no specific category is indicated, the API will return a list of reminders under the default category "mine." By default, the API provides a list of 20 reminders. | |
Retrieve a reminder | Use this API to obtain details of a specific reminder by providing the reminder ID in the query. You can retrieve the reminder ID from the API's response that lists all reminders. | |
Update a reminder | Use this API to edit the details of a specific reminder by providing the reminder ID | |
Delete a reminder | Use this API to delete a particular reminder by giving the reminder ID. | |
Delete Reminders | Use this API to delete a list of reminders by providing the reminder IDs | |
Delete completed reminders | Use this API to delete the list of reminders that are marked as complete. | |
Mark a reminder as complete | Use this API to mark a reminder as complete by providing the reminder ID | |
Mark a reminder as incomplete | Use this API to mark a reminder as incomplete by providing the reminder ID | |
Snooze a reminder | Use this API to snooze a reminder by providing the reminder ID. | |
Dismiss a snoozed reminder | Use this API to dismiss a snoozed reminder by providing the reminder ID | |
Assign users to a reminder | Use this API to assign users to reminders. A maximum of 4 users can be assigned to a reminder | |
Unassign a user from a reminder | Use this API to unassign users from a reminder, by providing their User ID. | |
Remind assignee | Use this API to trigger a notification in Taz to a particular assignee who is yet to mark the reminder as complete. | |
Remind assignees | Use this API to trigger a notification in Taz to a reminder's assignees who are yet to mark the reminder as complete. Note: This API will only work with reminders added in the Others category, i.e. reminders assigned by you to others. | |
| Roles | Get Roles | Use this API to fetch all available roles in your organization |
Create a Role | Use this API to create a custom role in your organization. | |
Retrieve role details | Use this API to retrieve detailed information about a specific role. | |
Edit a Role | Use this API to update a role in your organization | |
Delete a Role | Use this API to delete a role in your organization. | |
Get permissions of a role | Use this API to get the permissions of a role in your organization | |
Get users in a role | Use this API to get all the users in a specific role. | |
Add users to a role | Use this API to add users to a specific role. | |
Delete users from a role | Use this API to delete users from a specific role. | |
Create a Designation | Use this API to create a designation. This API will not return success if your Cliq organization is integrated with Zoho People. | |
Get Designations | Use this API to get the list of all designations in your organization. | |
Get Designation Details | Use this API to get details of a specific designation. | |
Update Designation | Use this API to update a designation's title. This API will not return success if your Cliq Organization is integrated with Zoho People. | |
Add Designation Members | Use this API to get members who are associated with a designation. | |
Delete Designation Members | Use this API to delete members associated with a designation | |
| Teams | Create a Team | Use this API to create teams |
List all Teams | Use this to get the list of all teams | |
Retrieve a Team | Use this to get details of a single team | |
Update a Team | Use this to update details of a single team | |
Delete a Team | Use this to delete a single team | |
Get Team Members | Use this API to retrieve a complete list of all members within a team. | |
Add Team Members | Use this API to add members in a team | |
Delete Team Members | Use this API to delete members in a team | |
Create a Department | Use this API to create a department. This API will not return success if your Cliq organization is integrated with Zoho People. | |
List all Departments | Use this API to get the list of all departments in your organization. | |
Get Department Details | Use this API to get details of a department. | |
Update Department | Use this API to update details of a department | |
Delete Department | Use this API to delete a department | |
Get Department Members | Use this API to get the list of all the department members | |
Add Department Members | Use this API to add members to a department | |
Delete Department Members | Use this API to delete members from a department | |
Add Users | Use this API to add a new user or a list of new users | |
Retrieve all users | Use this API to get details of all the users | |
Retrieve a particular user | Use this API to get details of a particular user | |
Update user details | Use this API to edit or update a user's details | |
Fetch list of user teams | Use this API to fetch the list of teams that the user belongs to. Head on over here to know more about team object attributes. | |
Get all userfields | Use this API to get the details of all userfields. | |
Add a userfield | Use this API to create a new custom userfield. Note: You can also encrypt the userfield if it contains sensitive data. | |
Retrieve a particular userfield | Use this API to get the details of a particular userfield. | |
Update a userfield | Use this API to update the details of a particular userfield. Note: When updating the drop_down type userfields, the unique ID's of the options should be unique i.e, they should not be repetitive. If multiple options have the same unique ID they will be replaced with one. | |
Delete a userfield | Use this API to delete a particular userfield | |
| User Status | Add a new status | Use this API to add a new status in Cliq. |
Retrieve all statuses | Use this API to retrieve the list of all your statuses in Cliq. | |
Delete transient status | Use this API to delete a status in Cliq. | |
Retrieve status of a user | Fetch a user's current status in Cliq. | |
Update current status | Use these APIs to update a given status ID as the current status. Retrieve the status ID using Retrieve All Statuses API. | |
Delete status | Use this API to delete a status in Cliq. | |
| Bots | Retrieve Bot Subscribers | Use these APIs to obtain the list of users currently subscribed to a bot. Access to bot subscribers is limited to the bot creator or administrator of the organization. |
Trigger Bot Calls | Utilize this API to send a voice alert to specific users via the bot. | |
Add a record | Use this API to add records to a database | |
List records | Use this API to get the list of all records in a specific database | |
Retrieve a record | Use this API to get details of a record by mentioning the record ID | |
| Update a record | Use this API to update record details from a specific database | |
Delete a record | Use this API to update record details from a specific database | |
Add or Update a ticker | Use this API to add a new ticker/update a ticker in the map view in widgets. | |
Delete a ticker | Use this API to delete an existing ticker in the map view in widgets. | |
| Calls and Meetings | Retrieve Calls and Meeting History | Use this API to get the details of all your direct calls, meetings, and broadcasts |
Get Participants of a call or meeting | Use this API to get all the participants in a call or a meeting | |
Get Calendars | Use this API to retrieve a comprehensive list of all calendars associated with a user | |
Get Events | Use this API to get the list of all your events scheduled within the next 31 days | |
Create an Event | Use this API to create an event. | |
Get Event Details | Use this API to get the event details of a specific event from the user's calendar | |
Edit an Event | Use this API to edit an event | |
Delete an Event | Use this API to delete an event | |
| Update a status of an event | Use this API to update your status for an event ( RSVP ) | |
Upload Attachments to Event Calendar | Use this API to upload an attachment in your calendar to attach it to events | |
Send a scheduled message | Use this API to schedule a message for delivery at a future date and time | |
| Files | Get Files | Get files from any chat, channel or bot which you are a part of using its file ID |
Share files to a channel | Share files to a bot using the bot unique name. The content of the file should be of type multipart/form-data | |
Share files to a bot | Share files to a bot using the bot unique name. | |
Share files in a chat | Share files in a chat using the Chat ID | |
Share files to a user | Share files to a user using their Email ID or User ID | |
| Remote Work | Get remote status | Use this API to get your remote status. |
Trigger Remote Check in | Use this API to check in remotely. | |
Trigger Remote Check out | Use this API to check out remotely | |
| Bulk Export | Export Conversations in Bulk | Use this API to export specific details of all individual chats and group conversations in your organization. |
Export Channels in Bulk | Use this API to export details of all the channels in your organization. | |
Export Members in a Conversation | Use this API to exclusively export the details of members from a specific chat or channel. | |
Export Messages in a Conversation | Use this API to export transcripts or history of all conversations in your organization. | |
| Custom Domain | Retrieve a custom domain | Use this API to get details about an individual custom domain. |
Add a custom domain | Use this API to add a new custom domain | |
Delete a custom domain | Use this API to delete a custom domain | |
Verify a custom domain | Use this API to verify a custom domain | |
Retrieve global mail configuration | Use this API to retrieve a global mail configuration | |
Update mail configuration | Use this API to update a mail configuration |