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.
Bots
| Operation ID | Summary | Description |
|---|---|---|
| list_bots | List all bots | List all bots available to the authenticated user. |
| create_bot | Create a bot | Create a new bot in Cliq with a display name, description, and access level. |
| get_bot | Retrieve details of a specific bot | Retrieve the full configuration and details of a specific bot. |
| update_bot | Update an existing bot | Update an existing bot's display name, description, access level, or logo. |
| delete_bot | Delete a specific bot | Permanently delete a bot and all its handlers and configuration. |
| get_bot_handler | Get details of a specific bot handler | Retrieve the configuration and Deluge code of a specific bot handler. |
| create_bot_handler | Create a handler for a specific bot | Create a handler for a bot to define its behavior for a trigger event. |
| update_bot_handler | Update a handler for a specific bot | Update a bot handler's execution logic or configuration. |
| delete_bot_handler | Delete a handler from a specific bot | Permanently remove a handler from a bot. |
| list_bot_handler_executions | List execution records of a specific bot handler | List execution records for a specific bot handler within a time range. |
| trigger_bot_call | Trigger Bot Calls | Send a voice alert to specific users via a bot. |
| send_bot_webhook_message | Send an incoming webhook message to a bot | Post a message to a bot via its incoming webhook URL. |
| send_bot_message_v2 | Send a bot message | Send a message from a bot to specific users, a channel, or all subscribers. |
| list_bot_subscribers_v2 | List all subscribers of a specific bot | List subscribers of a specific bot with pagination support. |
Bulk Export
| Operation ID | Summary | Description |
|---|---|---|
| bulk_export_conversations | Export Conversations | Export details of all chats and group conversations in the organization. |
| bulk_export_channels | Export Channels | Export details of all channels in the organization. |
| bulk_export_chat_members | Export Members in a Conversation | Export member details from a specific chat or channel. |
| bulk_export_chat_messages | Export Messages | Export message transcripts or history of all conversations in the organization. |
Buttons
| Operation ID | Summary | Description |
|---|---|---|
| messageCardButtons | Send a message with buttons | Send a message with interactive buttons to a chat. |
Calls & Meetings
| Operation ID | Summary | Description |
|---|---|---|
| list_calls_and_meetings | History | Retrieve details of all direct calls, meetings, and broadcasts. |
| list_call_participants | Get Participants | Retrieve all participants in a specific call or meeting. |
Channels
| Operation ID | Summary | Description |
|---|---|---|
| list_channels | List all channels | List channels accessible to the authenticated user with optional filters. |
| create_channel | Create a channel | Create a new channel in Cliq. |
| get_channel | Retrieve a channel | Retrieve details of a specific channel. |
| update_channel | Update a channel | Update the details and configuration of a specific channel. |
| delete_channel | Delete a channel | Delete an existing channel. |
| list_channel_members | Get Channel Members | List all members in a channel. |
| add_channel_members | Add Channel Members | Add members to a channel by user ID or email. |
| remove_channel_members | Delete Channel Members | Remove multiple members from a channel. |
| update_channel_member_role | Update a Channel member's role | Update the role of a member in a channel. |
| remove_channel_member | Delete a Channel Member | Remove a member from a channel by user ID or email. |
| approve_channel | Approve a Channel | Approve a newly created organization-level channel. |
| reject_channel | Reject a Channel | Reject a newly created organization-level channel. |
| join_channel | Join a Channel | Join a channel as the authenticated user. |
| leave_channel | Leave a Channel | Leave a channel as the authenticated user. |
| archive_channel | Archive a Channel | Archive a channel to stop new messages. |
| unarchive_channel | Unarchive a Channel | Unarchive a channel to resume messaging. |
| add_bot_to_channel | Add a Bot to a Channel | Add a bot to a channel using the bot's unique name. |
Chats
| Operation ID | Summary | Description |
|---|---|---|
| list_chats | Retrieve all direct chats | List all direct chats and group chats the authenticated user participates in. |
| createChatV3 | Create chat | Create a new direct message or group chat with one or more participants. |
| bulkUpdateChatsV3 | Mark Multiple Chats as Read or Clear Unread Count | Mark multiple chats as read, unread, or clear unread counts in a single request. |
| list_chat_members | Retrieve members of a chat | List all members participating in a specific group chat or channel. |
| get_chat | Retrieve chat details | Retrieve details of a specific chat by its unique identifier. |
| update_chat | Perform chat operations | Update a chat's title, history settings, read status, or close the chat. |
| searchChatsV3 | Search chats | Search for chats by name, type, date range, or participant. |
| send_typing_indicator | Send Typing Indicator | Send a typing indicator to a chat to signal the user is composing a message. |
| fork_chat | Fork a chat | Create a new chat by forking selected messages from an existing chat. |
| pin_chat_v2 | Pin chat | Pin a chat for the authenticated user, optionally under a category. |
| unpin_chat_v2 | Unpin chat | Remove the pin from a chat for the authenticated user. |
| add_chat_members | Add members to a chat | Add one or more users to an existing group chat. |
| remove_chat_members | Remove members from a chat | Remove one or more users from an existing group chat. |
| list_threads | List threads in a chat | List all thread chats for a parent chat. |
| get_thread_details | Get thread details | Retrieve details of a thread by its thread chat ID. |
| leave_group_chat | Leave a chat | Remove the authenticated user from a group chat or channel. |
| mute_chat | Mute a chat | Mute notifications for a chat while keeping the user as an active participant. |
| unmute_chat | Unmute a chat | Restore notifications for a previously muted chat. |
Custom Domain
| Operation ID | Summary | Description |
|---|---|---|
| get_custom_domain | Retrieve a custom domain | Retrieve details of a custom domain. |
| add_custom_domain | Add a custom domain | Add a new custom domain to the organization. |
| verify_custom_domain | Verify a custom domain | Verify ownership of a custom domain. |
| delete_custom_domain | Delete a custom domain | Delete a custom domain from the organization. |
Custom Email
| Operation ID | Summary | Description |
|---|---|---|
| get_mail_configuration | Retrieve global mail configuration | Retrieve the global mail configuration. |
| update_mail_configuration | Update mail configuration | Update the global mail configuration. |
| reset_mail_configuration | Reset mail configuration | Reset the global mail configuration to system defaults. |
Databases
| Operation ID | Summary | Description |
|---|---|---|
| list_database_records | List records | List all records in a specific database. |
| create_database_record | Add a record | Add a record to a database. |
| get_database_record | Retrieve a record | Retrieve a database record by its ID. |
| update_database_record | Update a record | Update a record in a specific database. |
| delete_database_record | Delete a record | Delete a record from a specific database. |
Datastores
| Operation ID | Summary | Description |
|---|---|---|
| list_datastores_v2 | List all datastores | List all datastores defined for the organization. |
| create_datastore_v2 | Create a datastore | Create a new datastore for the organization. |
| get_datastore_v2 | Get a datastore | Retrieve the metadata and field schema of a specific datastore. |
| update_datastore_v2 | Edit a datastore | Update the name or description of an existing datastore. |
| delete_datastore_v2 | Delete a datastore | Permanently delete a datastore and all its stored records. |
| update_datastore_fields_v2 | Edit datastore fields | Update the schema definitions of existing fields in a datastore. |
| list_datastore_records_v2 | List records from a datastore | Retrieve records from a datastore with optional filtering and pagination. |
| create_datastore_record_v2 | Add records to a datastore | Insert a record into a datastore. |
| bulk_update_datastore_records_v2 | Bulk update records in a datastore | Update multiple records in a datastore in a single request. |
| bulk_delete_datastore_records_v2 | Delete records from a datastore | Delete one or more records from a datastore. |
| get_datastore_record_v2 | Get a record from a datastore | Retrieve a single record from a datastore. |
| update_datastore_record_v2 | Update a record in a datastore | Update a single record in a datastore. |
| delete_datastore_record_v2 | Delete a record from a datastore | Permanently delete a single record from a datastore. |
| export_datastore_records_v2 | Export datastore records | Initiate a bulk export of all records from a datastore. |
Departments
| Operation ID | Summary | Description |
|---|---|---|
| list_departments | List all Departments | List all departments in the organization. |
| create_department | Create a Department | Create a department in the organization. |
| get_department | Get Department Details | Retrieve details of a specific department. |
| update_department | Update Department | Update the details of a specific department. |
| delete_department | Delete Department | Delete a department from the organization. |
| list_department_members | Get Department Members | List all members of a specific department. |
| add_department_members | Add Department Members | Add members to a department. |
| remove_department_members | Delete Department Members | Remove members from a department. |
Designations
| Operation ID | Summary | Description |
|---|---|---|
| list_designations | Get Designation Details | List all designations in the organization. |
| create_designation | Create a Designation | Create a designation in the organization. |
| get_designation | Get Designation Details | Retrieve details of a specific designation. |
| update_designation | Update Designation | Update a designation's title. |
| delete_designation | Delete Designation | Delete a designation from the organization. |
| list_designation_members | Get Designation Members | List all members associated with a designation. |
| add_designation_members | Add Designation Members | Add members to a designation. |
| remove_designation_members | Delete Designation Members | Remove members from a designation. |
DND Settings
| Operation ID | Summary | Description |
|---|---|---|
| get_dnd_settings | Get DND preferences | Retrieve the current Do Not Disturb settings for the authenticated user. |
| update_dnd_settings | Update DND preferences | Update Do Not Disturb settings for the authenticated user. |
Events
| Operation ID | Summary | Description |
|---|---|---|
| list_calendars | Get Calendars | List all calendars associated with the authenticated user. |
| list_events | Get Events | List all events scheduled within the next 31 days. |
| create_event | Create an Event | Create a new calendar event. |
| get_event | Get Event Details | Retrieve details of a specific calendar event. |
| update_event | Edit an Event | Update details of an existing calendar event. |
| delete_event | Delete an Event | Delete a calendar event. |
| update_event_status | Update an Event Status | Update your RSVP status for a calendar event. |
| upload_event_attachment | Upload Attachments to Event Calendar | Upload an attachment to your calendar to attach to events. |
Extensions
| Operation ID | Summary | Description |
|---|---|---|
| list_extension_properties | Get extension properties | List all configuration properties of an installed extension. |
| get_extension_property | Get a specific extension property | Retrieve a single configuration property of an installed extension. |
| delete_extension_property | Delete a specific extension property | Permanently delete a single configuration property of an installed extension. |
| create_extension_handler | Create a handler for a specific extension | Add a lifecycle handler to an extension. |
| get_extension_handler | Get details of a specific extension handler | Retrieve the configuration and Deluge code of a named extension handler. |
| update_extension_handler | Update a handler for a specific extension | Update the Deluge code of a named handler attached to an extension. |
| delete_extension_handler | Delete a handler from a specific extension | Permanently remove a named handler from an extension. |
| list_extension_handler_executions | List execution records of a specific extension handler | List execution records for a specific extension handler within a time range. |
| install_an_extension | Install an extension | Install a Cliq extension in an organization. |
| update_extension | Upgrade an extension | Upgrade an installed Cliq extension to a newer version. |
| add_or_update_extension_proper | Add or update extension properties | Add or update configuration properties for an installed extension. |
Files
| Operation ID | Summary | Description |
|---|---|---|
| get_file | Get Files | Retrieve a file from a chat, channel, or bot using its file ID. |
| share_file_to_channel | Share files to a channel | Share a file to a channel using the channel ID. |
| share_file_to_bot | Share files to a bot | Share a file to a bot using the bot's unique name. |
| share_file_to_chat | Share files in a chat | Share a file to a chat using the chat ID. |
| share_file_to_user | Share files to a user | Share a file to a user by their email or user ID. |
Functions
| Operation ID | Summary | Description |
|---|---|---|
| list_functions_v2 | List all functions | List all functions created by the authenticated user. |
| create_function_v2 | Create a new function | Create a new function in the Cliq platform. |
| get_function_v2 | Get details of a specific function | Retrieve the full configuration of a specific function. |
| update_function_v2 | Update an existing function | Update the name or description of an existing function. |
| delete_function_v2 | Delete a specific function | Permanently delete a function and all its associated handlers. |
| create_function_handler_v2 | Create a handler for a specific function | Add a handler to an existing function. |
| get_function_handler_v2 | Get details of a specific function handler | Retrieve the configuration and Deluge code of a function handler. |
| update_function_handler_v2 | Update a handler for a specific function | Update a handler for a specific function. |
| delete_function_handler_v2 | Delete a handler from a specific function | Permanently remove an execution handler from a function. |
Keyboard Shortcuts
| Operation ID | Summary | Description |
|---|---|---|
| list_keyboard_shortcuts | Fetch all keyboard shortcuts | List all keyboard shortcuts for the authenticated user. |
| update_keyboard_shortcuts | Update keyboard shortcuts | Update default or custom keyboard shortcuts for the authenticated user. |
| delete_keyboard_shortcuts | Delete keyboard shortcuts customization | Reset all custom keyboard shortcuts to defaults. |
Map Tickers
| Operation ID | Summary | Description |
|---|---|---|
| upsert_map_ticker | Add/Update a ticker | Add or update a ticker in the map view of a widget. |
| delete_map_ticker | Delete a ticker | Delete a ticker from the map view of a widget. |
Mentions
| Operation ID | Summary | Description |
|---|---|---|
| list_mentions | Retrieve Mentions and Replies | List messages where the authenticated user has been mentioned or replied to. |
| mention_user | Mentioning a User | Mention a user in a message using their Zoho ID or email syntax. |
| mention_user_silent | Silent mentions | Silently mention a user in a message without sending a notification. |
| mention_channel | Mentioning a Channel | Mention a channel in a message to notify all its participants. |
| mention_all_users | Mentioning all users in a channel | Mention all users in a channel using the @all syntax. |
| mention_available_users | Mentioning available users in a Channel | Mention all currently available users in a channel using the @available syntax. |
| mention_team | Mentioning a Team | Mention a team in a message to notify all its members. |
Message Actions
| Operation ID | Summary | Description |
|---|---|---|
| list_message_actions_v2 | List all message actions | List all message actions available to the user. |
| create_message_action_v2 | Create a new message action | Create a new message action for the message context menu. |
| get_message_action_v2 | Get details of a specific message action | Retrieve details of a specific message action. |
| update_message_action_v2 | Update an existing message action | Update the configuration of an existing message action. |
| delete_message_action_v2 | Delete a specific message action | Permanently delete a message action and its handler. |
| get_message_action_handler_v2 | Get details of a specific message action handler | Retrieve the Deluge code and configuration of a message action handler. |
| update_message_action_handler_v2 | Update a handler for a specific message action | Update a handler for a specific message action. |
Message Cards
| Operation ID | Summary | Description |
|---|---|---|
| send_message_card_to_chat | Post a message card to a chat | Send a structured message card to a chat conversation. |
| send_message_card_to_channel_v2 | Post a message card to a channel | Send a structured message card to a specific channel. |
Message Format
| Operation ID | Summary | Description |
|---|---|---|
| textmessageformat | Send a formatted message | Send a formatted message to a chat using text, table, list, label, image, chart, or graph. |
Messages
| Operation ID | Summary | Description |
|---|---|---|
| list_messages | Get Messages | Retrieve messages from a chat conversation the user has access to. |
| get_message | Retrieve a message | Retrieve a specific message from a chat conversation. |
| send_message_to_chat | Post message in chat | Post a message to a chat or thread. |
| send_message_to_chat_legacy | Post message in chat (by chat ID) | Post a message to a chat or thread by its chat ID. |
| send_message_to_channel | Post message in a channel | Post a message to a channel using the channel's unique name. |
| send_message_to_user | Post message to a user | Send a direct message to a user by specifying their email ID. |
| send_message_to_bot | Post message to a bot | Send a message to a bot using its unique name. |
| postMessageInChannelByChannelUniqueName | Post message in a channel with CHANNEL_UNIQUE_NAME | Post a message to a channel using its unique name. |
| postMessageInChannelByChannelId | Post message in a channel with CHANNEL_ID | Post a message to a channel using its channel ID. |
| update_message | Edit a message | Edit the text of an existing message in a conversation. |
| delete_message | Delete a message | Delete a specific message from a conversation. |
| delete_messages | Delete Multiple Messages | Delete multiple messages from a chat. |
| Forward_Messages | Forward Messages | Forward one or more messages from a source chat to other chats or users. |
| searchMessagesV3 | Search Messages | Search for messages across chats with filtering by keyword, sender, date, or file. |
| list_reactions | Get Reactions | Retrieve all reactions on a specific message. |
| add_reaction | Add a reaction | Add an emoji reaction to a message in a chat. |
| delete_reaction | Delete a reaction | Remove an emoji reaction from a message. |
Mobile Settings
| Operation ID | Summary | Description |
|---|---|---|
| get_mobile_settings | Get mobile settings | Retrieve mobile notification and media settings for the authenticated user. |
| update_mobile_settings | Update mobile settings | Update mobile notification and media settings for the authenticated user. |
My Pins
| Operation ID | Summary | Description |
|---|---|---|
| list_chat_folders | Retrieve chat folders | List all chat folders and their pinned chats for the authenticated user. |
| create_chat_folder | Create a chat folder | Create a new chat folder under the My Pins section. |
| update_chat_folder | Modify a chat folder | Update the title, symbol, or state of a chat folder. |
| delete_chat_folder | Delete a chat folder | Delete a chat folder, optionally unpinning all chats within it. |
| pin_chat_to_folder | Pin a chat to a chat folder | Pin a chat to the My Pins section or a specific chat folder. |
| reorder_chat_in_folder | Reorder a chat within a chat folder | Reorder a pinned chat within a chat folder. |
| reorder_chat_folder | Reorder a chat folder | Reorder a chat folder within the list of chat folders. |
| replace_chats_in_folder | Replace chats in a chat folder | Replace all chats in a chat folder with a new set of chats. |
| remove_chats_from_all_folders | Remove pinned chats across chat folders | Remove specific pinned chats from all chat folders. |
Pin Messages
| Operation ID | Summary | Description |
|---|---|---|
| list_pinned_messages | Get pinned messages | List all pinned messages in a chat, sorted by most recently pinned. |
| pin_message | Add a pinned message | Pin a message in a chat. |
| reorder_pinned_messages | Reorder pinned messages | Reorder a pinned message within the chat's pinned list. |
| unpin_message | Delete pinned messages | Remove one or more pinned messages from a chat. |
| get_pinned_message | Get primary pinned message | Retrieve the primary pinned message in a chat. |
Reminders
| Operation ID | Summary | Description |
|---|---|---|
| list_reminders | Get list of all reminders | List all reminders for the authenticated user. |
| create_reminder | Create a reminder | Create a reminder for yourself, a teammate, a chat, or a message. |
| get_reminder | Retrieve a reminder | Retrieve details of a specific reminder by its ID. |
| update_reminder | Update reminder status | Mark a recurring reminder as complete across all occurrences. |
| delete_reminder | Delete a reminder | Delete a reminder by its ID. |
| bulk_delete_reminders | Delete Reminders | Delete multiple reminders by their IDs. |
| delete_completed_reminders | Delete completed reminders | Delete all reminders that are marked as complete. |
| mark_reminder_complete | Mark a reminder as complete | Mark a reminder as complete by its ID. |
| mark_reminder_incomplete | Mark a reminder as incomplete | Mark a reminder as incomplete by its ID. |
| snooze_reminder | Snooze a reminder | Snooze a reminder to delay its notification. |
| dismiss_snoozed_reminder | Dismiss a snoozed reminder | Dismiss the snooze on a snoozed reminder. |
| assign_reminder_users | Assign users to a reminder | Assign up to four users to a reminder. |
| unassign_reminder_user | Unassign a user from a reminder | Unassign a user from a reminder. |
| remind_assignee | Remind assignee | Send an immediate reminder notification to a specific assignee. |
| remind_assignees | Remind assignees | Send an immediate reminder notification to all pending assignees. |
| trigger_reminder_notification | Trigger reminder notification to assignees | Immediately notify all assignees of a reminder, bypassing the scheduled time. |
| list_chat_reminders | Get reminders in a chat | List all reminders set on messages within a specific chat. |
| bulk_update_reminders | Batch edit reminders | Reschedule multiple reminders in a single request. |
Remote Work
| Operation ID | Summary | Description |
|---|---|---|
| get_remote_work_status | Get remote status | Retrieve the authenticated user's remote work check-in status. |
| remote_check_in | Trigger Remote Check in | Check in the authenticated user as working remotely. |
| remote_check_out | Trigger Remote Check out | Check out the authenticated user from remote work. |
Roles
| Operation ID | Summary | Description |
|---|---|---|
| list_roles | Get Roles | List all roles in the organization. |
| create_role | Create a Role | Create a custom role in the organization. |
| get_role | Retrieve role details | Retrieve details of a specific role. |
| update_role | Edit a Role | Update a role in the organization. |
| delete_role | Delete a Role | Delete a role from the organization. |
| list_role_permissions | Get permissions of a role | List all permissions assigned to a role. |
| update_role_permissions | Update permissions of a role | Update the permissions of a role. |
| list_role_users | Get users in a role | List all users assigned to a specific role. |
| add_role_users | Add users to a role | Add users to a specific role. |
| remove_role_users | Delete users from a role | Remove users from a specific role. |
Scheduled Messages
| Operation ID | Summary | Description |
|---|---|---|
| create_scheduled_message | Create a scheduled message | Schedule a message for delivery at a future time or when a recipient's status changes. |
| get_scheduled_message | Get a scheduled message | Retrieve details of a specific scheduled message in a chat. |
| listScheduledMessagesInChatV3 | List scheduled messages in a chat | List all scheduled messages in a specific chat or channel. |
| listAllScheduledMessagesV3 | List all scheduled messages | List all scheduled messages across all chats for the authenticated user. |
| editScheduledMessageV3 | Edit a scheduled message | Update the text, schedule, timezone, or attachment of a scheduled message. |
| sendScheduledMessagesNowV3 | Send scheduled messages now | Immediately send one or all pending scheduled messages in a chat. |
| bulkRescheduleScheduledMessagesV3 | Bulk reschedule scheduled messages | Reschedule all time-based or status-based scheduled messages in a chat. |
| deleteScheduledMessageV3 | Delete a scheduled message | Delete a specific scheduled message by its ID. |
| deleteAllScheduledMessagesInChatV3 | Delete all scheduled messages in a chat | Delete all scheduled messages in a chat in a single operation. |
Schedulers
| Operation ID | Summary | Description |
|---|---|---|
| list_schedulers_v2 | List all schedulers | List all schedulers defined for the organization. |
| get_scheduler_handler_v2 | Get details of a specific scheduler handler | Retrieve the configuration and Deluge code of a scheduler's handler. |
| update_scheduler_handler_v2 | Update a handler for a specific scheduler | Update the Deluge code of a scheduler's execution handler. |
| list_scheduler_handler_executions_v2 | List execution records of a specific scheduler handler | List execution records for a scheduler handler within a time range. |
Slash Commands
| Operation ID | Summary | Description |
|---|---|---|
| list_slash_commands_v2 | List all commands | List all custom slash commands. |
| create_slash_command_v2 | Create a slash command | Create a new slash command. |
| get_slash_command_v2 | Get a command | Retrieve details of a specific slash command. |
| update_slash_command_v2 | Update a slash command | Update the configuration of an existing slash command. |
| delete_slash_command_v2 | Delete a slash command | Permanently delete a custom slash command and all its handlers. |
| create_slash_command_handler_v2 | Create a handler for a specific command | Add a handler to an existing slash command. |
| get_slash_command_handler_v2 | Get details of a specific command handler | Retrieve the Deluge code and configuration of a slash command handler. |
| update_slash_command_handler_v2 | Update a handler for a specific command | Update a handler for a specific slash command. |
| delete_slash_command_handler_v2 | Delete a handler from a specific command | Permanently remove a specified handler from a slash command. |
Stars
| Operation ID | Summary | Description |
|---|---|---|
| list_starred_messages | List starred messages | List all starred messages for the authenticated user. |
| star_a_message | Star a Message or Update Star Type | Star a message with a specific star type. |
| unstar_message | Unstar a Message | Remove the star from a specified message. |
Teams
| Operation ID | Summary | Description |
|---|---|---|
| list_teams | List all Teams | List all teams in the organization. |
| create_team | Create a Team | Create a new team in the organization. |
| get_team | Retrieve a Team | Retrieve details of a specific team. |
| update_team | Update a Team | Update the details of a specific team. |
| delete_team | Delete a Team | Delete a team from the organization. |
| list_team_members | Get Team Members | List all members of a specific team. |
| add_team_members | Add Team Members | Add members to a team. |
| remove_team_members | Delete Team Members | Remove members from a team. |
Threads
| Operation ID | Summary | Description |
|---|---|---|
| create_thread_by_channel_id | Create and send a thread message with CHANNEL_ID | Create a thread from a message in a channel identified by its channel ID. |
| create_thread_by_chat_id | Create and send a thread message with CHAT_ID | Create a thread from a message in a channel identified by its chat ID. |
| create_thread_by_channel_name | Create and send a thread message with CHANNEL_UNIQUE_NAME | Create a thread from a message in a channel identified by its unique name. |
| create_thread_in_channel | Create and send a thread message | Create a thread from a message sent in a channel. |
| send_thread_message | Send a message to an existing thread | Send a message to an existing thread. |
| send_thread_message_by_chat | Send a message to an existing thread (by chat) | Send a message to an existing thread by chat ID. |
| get_thread | Retrieve thread details | Retrieve details of a thread by its thread chat ID. |
| update_thread_state | Update the state of a thread | Update the state or follow status of a thread. |
| get_thread_main_message | Get main message of a thread | Retrieve the main message from which a thread was created. |
| list_thread_followers | Get thread followers | List all followers of a specific thread. |
| add_thread_followers | Add followers to a thread | Add one or more users as followers to a thread. |
| remove_thread_followers | Remove followers from a thread | Remove one or more users from a thread's followers list. |
| list_thread_non_followers | Get non-followers of a thread | List channel members who are not following a specific thread. |
| follow_thread | Join (follow) a thread | Follow a thread to receive notifications for new replies. |
| unfollow_thread | Leave (unfollow) a thread | Unfollow a thread to stop receiving notifications. |
| list_thread_members | Retrieve members of a thread | List all participants of a specific thread conversation. |
| leave_thread | Leave a thread | Remove the authenticated user from a thread conversation. |
| mute_thread | Mute a thread | Mute notifications for a thread while remaining an active participant. |
| unmute_thread | Unmute a thread | Restore notifications for a previously muted thread. |
| list_channel_threads | Get threads of a channel | List all threads in a chat or channel. |
| auto_follow_thread | Auto follow | Configure auto-follow settings for all threads created in a channel. |
User Fields
| Operation ID | Summary | Description |
|---|---|---|
| list_user_fields | Get all userfields | List all custom user fields in the organization. |
| create_user_field | Add a userfield | Create a new custom user field. |
| get_user_field | Retrieve a particular userfield | Retrieve details of a specific user field. |
| update_user_field | Update a userfield | Update the details of a specific user field. |
| delete_user_field | Delete a userfield | Delete a specific user field. |
User Preferences
| Operation ID | Summary | Description |
|---|---|---|
| get_user_preferences | Get user preferences | Retrieve the full preference set for the authenticated user. |
| update_user_preferences | Update user preferences | Update one or more preferences for the authenticated user. |
Users
| Operation ID | Summary | Description |
|---|---|---|
| list_users | Retrieve all users | List all users in the organization. |
| invite_users | Add Users | Invite one or more new users to the organization. |
| get_user | Retrieve a particular user | Retrieve details of a specific user. |
| update_user | Update user details | Update a user's details. |
| list_user_teams | Fetch list of user teams | List all teams that a specific user belongs to. |
| list_user_field_layouts | List user field layouts | List all layout configurations for user fields. |
Users Status
| Operation ID | Summary | Description |
|---|---|---|
| list_statuses | Retrieve all statuses | List all custom statuses set by the authenticated user. |
| create_status | Add a new status | Create a new custom status in Cliq. |
| add_transient_status | Add a transient status | Set a temporary transient status in Cliq. |
| delete_transient_status | Delete transient status | Clear the current transient status. |
| get_current_status | Retrieve current status | Retrieve the authenticated user's current status. |
| get_user_status | Retrieve a user's status | Retrieve the current status of a specific user. |
| update_current_status | Update current status | Set a saved status as the current active status. |
| delete_status | Delete status | Delete a custom status. |
Widgets
| Operation ID | Summary | Description |
|---|---|---|
| get_widget_v2 | Get a widget | Retrieve the configuration of a specific widget. |
| update_widget_v2 | Edit a widget | Update the name, description, or access level of an existing widget. |
| get_widget_handler_v2 | Get details of a specific widget handler | Retrieve the Deluge code and configuration of a widget handler. |
| update_widget_handler_v2 | Update a handler for a specific widget | Update the Deluge code of a widget handler. |
| list_widget_handler_executions_v2 | List execution records of a specific widget handler | List execution records for a widget handler within a time range. |
| upsert_map_ticker | Add/Update a ticker | Add or update a ticker in the map view of a widget. |
| delete_map_ticker | Delete a ticker | Delete a ticker from the map view of a widget. |