Authentication: OAuth. See Magic Link for the runtime auth flow, or Application credentials to bring your own OAuth app.
Sample use cases
- Post the daily standup summary to the
#engineeringchannel - List the messages in the
Support Escalationschat from today - Create a channel for the
Q3 Launchproject and add the team
Available Tools
Add a bot to a channel, by the bot’s unique name (ask the user) and the channel’s unique name (use list_channels). Th…
Add members to a channel by user ID or email. Supply user_ids (use list_users) or email_ids. Use list_channels to fin…
Add a custom domain to the organization. Requires name (the domain). After adding, verify ownership with verify_custo…
Add members to a department. Requires user_ids. Use list_departments for department IDs and list_users for user IDs…
Add members to a designation. Requires user_ids. Use list_designations for designation IDs and list_users for user ID…
Add an emoji reaction to a message in a chat. Use list_chats for chat IDs, list_messages for message IDs, and list_re…
Add users to a role. Requires user_ids. Use list_roles for role IDs and list_users for user IDs. Inverse: remove_role…
Add members to a team. Requires user_ids (use list_users to find user IDs). Use list_teams to find team IDs. Inverse…
Add one or more users as followers of a thread, so they receive reply notifications. Notifies the added users. Use li…
Set a temporary (transient) status that automatically expires at a given time. Requires code (‘available’, ‘busy’, or…
Approve a newly created organization-level channel that is awaiting approval (status ‘pending’). Admin only. Use list…
Archive a channel to stop new messages. Use list_channels to find channel IDs. Inverse: unarchive_channel.
Assign up to 4 users to a reminder, so they are notified when it fires. Use list_reminders for reminder IDs and list_…
Delete multiple reminders by their IDs in one call (maximum 20). Use list_reminders to find reminder IDs.
Export org channels as CSV (admin only; fields default to all channel columns). Zoho returns the full export in one r…
Export chat members as CSV (admin only; use list_chats or list_channels for chat IDs; default fields: name, email, us…
Export a chat transcript as JSON (admin only; use list_chats or list_channels for chat IDs). Zoho returns the full tr…
Export org chats as CSV (admin only; default fields: title, chat_id). Zoho returns the full export in one response; t…
Create a new channel. Requires name and level. When level is ‘team’, also pass team_ids (use list_teams to find them)…
Add a record to a Cliq database. Requires database_name (use list_databases) and values keyed by the database’s field…
Create a department with a name, lead_zuid and at least one initial member in user_ids. Optionally provide parent_dep…
Create a designation (job title). Requires name (max 30 characters). Optionally associate users with user_ids (use li…
Create a calendar event. Sends calendar invites to the attendees you list, so it notifies those people. Requires titl…
Create a reminder for yourself, teammates, a chat, or a specific message. Requires content and time (Unix epoch milli…
Create a custom role. Requires name and profile_type (‘Members’, ‘Cliq Admin’, or ‘Admin’). Pass clone_id (use list_r…
Schedule a message for future delivery in a chat, either at a fixed time (schedule_time, ISO8601 basic yyyyMMddTHHmms…
Create a new saved custom status (presence code plus a message) for the authenticated user. Requires code (‘available…
Create a new team in the organization. Requires name. Pass user_ids (use list_users) to seed initial members. Returns…
Invite a new organization user by email. Requires email_id. Returns a batch summary (success_users, invited_users, fa…
Create a custom user field. Requires name. Set type (‘text_field’, ‘drop_down’, ‘date_picker’, etc.), mandatory, encr…
Delete a channel permanently by ID. Use list_channels to find channel IDs.
Delete all reminders that are marked complete, in one call. Takes no inputs.
Delete the organization’s custom domain. Admin only. Takes no inputs. Inverse of add_custom_domain.
Delete a record from a Cliq database permanently. Requires database_name (use list_databases) and record_id (use list…
Delete a department by ID. Admin only. Use list_departments to find department IDs. Inverse of create_department.
Delete a designation by ID. Admin only. Use list_designations to find designation IDs. Inverse of create_designation.
Delete a calendar event. Requires event_id, calendar_id, and the current edit_tag. Use list_events for event IDs and…
Delete a message from a chat permanently. Use list_chats for chat IDs and list_messages for message IDs. Requires cha…
Remove an emoji reaction from a message. Use list_chats for chat IDs, list_messages for message IDs, and list_reactio…
Delete a reminder by its ID. Use list_reminders to find reminder IDs. Inverse of create_reminder.
Delete a role by ID. Admin only. Use list_roles to find role IDs. Inverse of create_role.
Delete a saved custom status by its ID. Use list_statuses to find status IDs. Inverse of create_status.
Delete a team from the organization by ID. Use list_teams to find team IDs. Inverse of create_team.
Clear the authenticated user’s current transient status before it expires. Takes no inputs. Inverse of add_transient_…
Delete a custom user field by ID. Admin only. Use list_user_fields to find user-field IDs. Inverse of create_user_field.
Dismiss the snooze on a snoozed reminder, so it reverts to its original fire time. Use list_reminders to find reminde…
Follow a thread as the authenticated user to receive notifications for new replies. Use list_channel_threads to find…
Get a single channel by ID. Use list_channels to find channel IDs.
Get the authenticated user’s current active status (code, message, and id). Takes no inputs.
Get the organization’s custom domain and its verification status. Admin only. Takes no inputs.
Get one record from a Cliq database by its ID. Requires database_name (use list_databases) and record_id (use list_da…
Get a single department by ID, including its lead and member count. Admin only. Use list_departments to find departme…
Get a single designation by ID. Admin only. Use list_designations to find designation IDs.
Get the details of a specific event, including its edit_tag (needed by delete_event) and attendees. Requires event_id…
Retrieve a file from a chat, channel, or bot by its file ID. Returns a merge_file_transfer reference the file-handlin…
Get the organization’s global mail configuration (sender name, email address, and CNAME status). Admin only. Takes no…
Retrieve a single message from a chat by its ID. Use list_chats for chat IDs and list_messages for message IDs. Retur…
Get a single reminder by its ID, including its content, fire time, assignees, and any anchored chats. Use list_remind…
Get the authenticated user’s remote-work check-in status (whether checked in, since when, and session duration). Take…
Get a single role by ID, including its type and description. Admin only. Use list_roles to find role IDs.
Get a single team by ID. Use list_teams to find team IDs.
Get the main (parent) message a thread was created from, including its sender, content, and thread information. Use l…
Get a single user by ID. Use list_users to find user IDs.
Get a single user field by ID, including its type and options. Admin only. Use list_user_fields to find user-field IDs.
Get another user’s current presence (state, activity, and status text) by user ID. Use list_users to find user IDs. F…
Join a channel as the authenticated user. Use list_channels to find channel IDs. May notify the channel that the user…
Leave a channel as the authenticated user. Use list_channels to find channel IDs. May notify the channel that the use…
Remove the authenticated user from a group chat or channel. Use list_chats to find chat IDs. For a channel, leave_cha…
List the users subscribed to a bot, by the bot’s unique name (no API lists bots, so ask the user for it). Only the bo…
List all calendars associated with the authenticated user, including each calendar’s uid to pass as calendar_id to cr…
List the participants of a specific call or meeting, with an optional live/invited/joined filter and cursor paginatio…
List the authenticated user’s call history - direct calls, meetings, and broadcasts - with optional type, category fi…
List all members of a channel. Use list_channels to find channel IDs. Returns each member’s user_id for use with upda…
List the threads (threaded side-conversations) in a channel, with cursor pagination. Use list_channels to find channe…
List channels with optional server-side filters (name contains, status, level) and cursor pagination. Use for browsin…
List all members participating in a group chat or channel. Use list_chats to find chat IDs. Returns each member’s use…
List the current user’s chats (conversations). Page back by setting modified_before to the oldest returned chat’s las…
List records in a Cliq database, by its unique name (use list_databases). Filter server-side with criteria (e.g. ‘(pr…
List the Cliq databases the user can access, with each database’s unique name and fields. Pass a database’s name as d…
List the members of a department. Admin only. Use list_departments to find department IDs. Returns each member’s user…
List the organization’s departments, with an optional name search and cursor pagination. Admin only. Returns each dep…
List the members associated with a designation, with cursor pagination. Admin only. Use list_designations to find des…
List up to limit designations (max 100); this endpoint has no further pages. Use search to narrow results. Admin…
List the authenticated user’s events scheduled within the next 31 days, with optional time-window (from_time/to_time)…
List messages in a chat with optional server-side time filters (fromtime, totime) and time-based pagination. Use list…
List the pinned (sticky) messages in a chat, most recently pinned first. Use list_chats to find chat IDs. Requires ch…
List all reactions on a message, grouped by emoji with the users who added each. Use list_chats for chat IDs and list…
List reminders for the authenticated user, with cursor pagination. Use the category param to choose pending vs comple…
List all permissions assigned to a role, as a per-module mapping. Admin only. Use list_roles to find role IDs. Read t…
List the users assigned to a role. Admin only. Use list_roles to find role IDs. Returns each user’s user_id for use w…
List the organization’s roles (admin profiles). Admin only. Returns each role’s id for use with get_role, update_role…
List all custom statuses saved by the authenticated user. Returns each status’s id for use with update_current_status…
List all members of a team. Use list_teams to find team IDs. Returns each member’s user_id for use with remove_team_m…
List teams in the organization, optionally limited to teams the user has joined (joined=true). Returns team_id for us…
List the users following a thread (returns the full set, no pagination). Use list_channel_threads to find a thread’s…
List the channel members who are NOT following a thread (returns the full set, no pagination). Use list_channel_threa…
List the layout configurations for user fields. Admin only. Takes no inputs.
List all custom and system user fields in the organization. Admin only. Returns each field’s id for use with get_user…
List all teams a specific user belongs to. Use list_users to find user IDs. Returns each team’s team_id for use with…
List organization users with optional server-side filters (search by name/email, status) and cursor pagination. Retur…
Mark a reminder as complete by its ID. Use list_reminders to find reminder IDs. Inverse: mark_reminder_incomplete.
Mark a reminder as incomplete (reopen it) by its ID. Use list_reminders to find reminder IDs. Inverse of mark_reminde…
Mute notifications for a chat while keeping the user an active participant. Use list_chats to find chat IDs. Inverse…
Pin a message in a chat for a given duration. Set notify=true to notify participants that a message was pinned. Use l…
Reject a newly created organization-level channel that is awaiting approval (status ‘pending’). Admin only. Use list_…
Send an immediate reminder notification to one specific assignee, bypassing the scheduled time. Notifies that user no…
Send an immediate reminder notification to all pending assignees at once, bypassing the scheduled time. Notifies ever…
Check the authenticated user in as working remotely. Takes no inputs. This updates the user’s remote-work presence th…
Check the authenticated user out from remote work. Takes no inputs. This updates the user’s remote-work presence that…
Remove one or more members from a channel by user ID or email. Supply user_ids (use list_channel_members) or email_id…
Remove members from a department. Requires user_ids. Use list_departments for department IDs and list_department_memb…
Remove members from a designation. Requires user_ids. Use list_designations for designation IDs and list_designation_…
Remove users from a role. Requires user_ids. Use list_roles for role IDs and list_role_users for current member user…
Remove a member from a team by user ID. Use list_teams for team IDs and list_team_members for member user IDs. Invers…
Remove one or more users from a thread’s followers, so they stop receiving reply notifications. Use list_channel_thre…
Send a message as a bot to its subscribers, by the bot’s unique name (ask the user for it). Pass user_ids (use list_b…
Post a message to a channel, notifying its members. Requires channel_id and text. Use list_channels to find channel I…
Post a message to a chat, notifying its participants. Requires chat_id and text. Use list_chats to find chat IDs; a t…
Post a message to a channel by its unique name (not its ID). Notifies channel members. Use list_channels to find a ch…
Send a direct message to a user by their email address. Notifies the recipient. Use list_users to find a user’s email…
Share a file to a bot, by the bot’s unique name (ask the user for it). Pass the file as file_reference from the file…
Share a file to a channel by its unique name. Notifies channel members. Pass the file as file_reference from the file…
Share a file to a chat by its chat ID. Notifies chat participants. Pass the file as file_reference from the file uplo…
Share a file with a user by their email address. Notifies the recipient. Pass the file as file_reference from the fil…
Snooze a reminder to delay its notification by a duration (in milliseconds). Use list_reminders to find reminder IDs…
Place a voice alert from a bot to specific users: Cliq calls each user and reads text aloud, with optional retries an…
Unarchive a channel to resume messaging. Use list_channels (status=‘archived’) to find channel IDs. Inverse of archiv…
Unassign a user from a reminder, so they stop being notified. Use list_reminders for reminder IDs and get_reminder (t…
Stop following a thread as the authenticated user, to stop receiving reply notifications (also used to leave a thread…
Restore notifications for a previously muted chat. Use list_chats to find chat IDs. Inverse of mute_chat.
Remove the pinned (sticky) message from a chat. Use list_chats for chat IDs and list_pinned_messages to see what is p…
Update a channel’s name, description, and/or thread auto-follow setting by ID. Set auto_follow_threads to ‘enable’/‘d…
Change a member’s role in a channel. Requires role (one of super_admin, admin, moderator, member). Use list_channels…
Set a saved status as the authenticated user’s current active status, by status ID. Use list_statuses to find status…
Update fields of a record in a Cliq database. Requires database_name (use list_databases), record_id (use list_databa…
Update a department’s details. The edit endpoint requires name and lead_zuid on every call; parent_department_id is o…
Update a designation’s title. Requires name (max 30 characters). Use list_designations to find designation IDs. Overw…
Update a calendar event. Sends updated calendar invites to attendees, so it notifies those people. The edit endpoint…
Update your RSVP status for an event: accepted, tentative, declined, or yet_to_respond. Use list_events to find event…
Update the organization’s global mail configuration. The endpoint requires name, email_id and cname_status on every c…
Edit the text of an existing message in a chat. Set notify_edit=true to notify participants of the edit. Use list_cha…
Update a reminder’s content and/or fire time. Use list_reminders to find reminder IDs. Overwrites the fields you pass…
Update a role’s name and description. The edit endpoint requires both on every call. Use list_roles to find role IDs…
Update a role’s permissions. Pass a list of permission entries, each naming a module (and optionally an action, statu…
Update a team’s name and/or description by ID. Use list_teams to find team IDs. Overwrites the provided fields.
Set a thread’s state to ‘closed’ (stop new replies) or ‘open’ (reopen it). Use list_channel_threads to find a thread’…
Update a user’s profile fields by ID. Use list_users to find user IDs. Overwrites the provided fields.
Update a user field’s name, flags (mandatory, encrypted, edit_permission) or options. For a drop_down field, options…
Upload a file to your calendar so it can be attached to events. Pass the file as file_reference from the file upload…
Add or update tickers (live markers) on a widget’s map view. Requires widget_id and map_id (from the widget’s ticker…
Verify ownership of the organization’s custom domain by setting its status to ‘active’. Add the domain first with add…