{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bots chats API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "chats",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all direct chats",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/chats",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Search for chats with names that partially match the provided value.<br>\nFor example, searching with \"pro\" may return chats named \"Project Alpha\" and \"Product Launch\".\n"
              },
              {
                "name": "recipient",
                "value": "",
                "type": "query",
                "description": "Filter chats containing recipient.<br>\nProvide the recipient <code>USER_ID</code> to return chats that include that user as a participant.<br>\nTo learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#USER_ID\">USER_ID</a> in the Glossary page.<br>\nFor example, searching with <code>70027934</code> returns chats that include that user ID.\n"
              },
              {
                "name": "muted",
                "value": "",
                "type": "query",
                "description": "Set this parameter to true to retrieve the list of chats which are muted by the user.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of chats that has to be retrieved.<br>\n<b>Maximum limit</b> : 100\n"
              },
              {
                "name": "modified_before",
                "value": "",
                "type": "query",
                "description": "Gets the list of chats where the last message is sent before the mentioned time.\n<br>\nThe time should be in <b>epoch milliseconds</b> format.<br>For example, <code>1711929600000</code>.\n"
              },
              {
                "name": "modified_after",
                "value": "",
                "type": "query",
                "description": "Gets the list of chats where the last message is sent after the mentioned time.\n<br>\nThe time should be in <b>epoch milliseconds</b> format.<br>For example, <code>1711929600000</code>.\n"
              },
              {
                "name": "drafts",
                "value": "",
                "type": "query",
                "description": "Set this parameter to true to retrieve the list of chats which have unsent messages (drafts).\n"
              },
              {
                "name": "pinned",
                "value": "",
                "type": "query",
                "description": "Set this parameter to true to retrieve the list of chats which are pinned by the user.\n"
              },
              {
                "name": "closed",
                "value": "",
                "type": "query",
                "description": "Set this parameter to true to retrieve the list of chats which are closed by the user.\n"
              },
              {
                "name": "joined",
                "value": "",
                "type": "query",
                "description": "Set this parameter to true to retrieve the list of chats which are joined by the user.\n"
              },
              {
                "name": "chat_ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of chat IDs to filter the chats.<br>\nTo learn how to retrieve these IDs, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page.<br>\n"
              },
              {
                "name": "parent_chid",
                "value": "",
                "type": "query",
                "description": "Filter chats that are threads of a specific parent chat. Provide the parent chat's <code>CHAT_ID</code> to return all threads under that chat.<br>\nTo learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page.<br>\n"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter chats by type.<br>\n<b>Allowed values</b>:<br>\n<ul>\n  <li><code>threads</code> - Chats that are threads of a parent chat.</li>\n  <li><code>channel</code> - Channel conversations.</li>\n  <li><code>bot</code> - Conversations with bots.</li>\n  <li><code>dm</code> - Direct messages between users.</li>\n  <li><code>muted</code> - Chats that are muted by the user.</li>\n</ul>\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Use this API to get details of all direct chats.\n<br><br> \n<p>\n  <b>Threshold limit</b>: 30 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n"
        },
        {
          "info": {
            "name": "Create chat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Create a new direct conversation or a group chat.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 30 requests per min<br>\n  Number of API calls allowed within a minute.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint').textContent=this.open?'Click to collapse':'Click to expand'\">\n  <summary style=\"cursor:pointer; padding:11px 16px; font-weight:600; background:rgba(148,163,184,0.1)"
        },
        {
          "info": {
            "name": "Mark Multiple Chats as Read or Clear Unread Count",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cliq.zoho.com/api/v3/chats",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Manage the read state of multiple chats in a single request.<br> \nTwo bulk actions are supported, controlled by the <code>operation</code> field in the request body:\n<ul>\n  <li><code>read_status_update</code>- Manage the read status of multiple chats in a single request. This is particularly useful for keeping your chat list organized and up-to-date, especially when you have a large number of conversations.</li>\n  <li><code>clear_unread</code> - Clears the unread message count or status to zero "
        },
        {
          "info": {
            "name": "Search chats",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/chats/search",
            "params": [
              {
                "name": "title",
                "value": "",
                "type": "query",
                "description": "Search for chats that include this keyword in their names. The search should be case-insensitive and allow for partial matches.<br>\n<b>Maximum length</b>: 200 characters\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of chats to return.<br>\n<b>Maximum limit</b>: 500. Default is 500 if not specified.\n"
              },
              {
                "name": "modified_before",
                "value": "",
                "type": "query",
                "description": "Search and return only chats last modified before this time.<br>\nAccepts either epoch time in milliseconds (for example, <code>1711929600000</code>) or <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (for example, <code>2024-04-01T00:00:00Z</code>).<br>\nUse the same time format consistently across both <code>modified_before</code> and <code>modified_after</code> in a request for predictable filtering.\n<b>Note:</b> When both modified_before and modified_after are provided, modified_after must be earlier than modified_before.\n"
              },
              {
                "name": "modified_after",
                "value": "",
                "type": "query",
                "description": "Search and return only chats last modified after this time.<br>\nAccepts either epoch time in milliseconds (for example, <code>1711929600000</code>) or <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format (for example, <code>2024-04-01T00:00:00Z</code>).<br>\nUse the same time format consistently across both <code>modified_before</code> and <code>modified_after</code> in a request for predictable filtering.\n<b>Note:</b> When both modified_before and modified_after are provided, modified_after must be earlier than modified_before.\n"
              },
              {
                "name": "recipient",
                "value": "",
                "type": "query",
                "description": "Filter by recipient user ID. Returns chats where this user is a participant. For direct messages, this will be the other participant; for group chats, this can be any member.\n"
              },
              {
                "name": "chat_type",
                "value": "",
                "type": "query",
                "description": "Filter by chat type.\nAllowed values:<br><code>direct_message</code>, <code>group_chat</code>, <code>channel</code>, <code>thread</code>. You can specify multiple types separated by commas (e.g. <code>direct_message,group_chat</code>) to include multiple chat types in the results.\n"
              },
              {
                "name": "parent_chat_id",
                "value": "",
                "type": "query",
                "description": "Restrict results to threads belonging to this parent chat. Only applicable when filtering for thread-type chats.\n"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Sort results by usage or recent activity.<br>\n<b>Allowed values</b>:<br>\n<ul>\n  <li><code>usage</code>: Sort by usage frequency, with the most frequently accessed chats appearing first.</li>\n  <li><code>recent</code>: Sort by recent activity, with the most recently active chats appearing first. This is the default sorting method.</li> \n</ul>\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Search for chats accessible to the current user. You can filter by name, type, date range, participant, and more.\n<br><br> \n<p>\n  <b>Threshold limit</b>: 50 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint').tex"
        },
        {
          "info": {
            "name": "Retrieve chat details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of response fields to include (max 20).<br>\nBy default, a standard set of fields is returned. Use this parameter to include additional fields or to optimize performance by excluding unnecessary data.<br>\n<b>Example</b>: <code>https://cliq.zoho.com/api/v3/chats/{CHAT_ID}?fields=title,chat_type,participant_count,permissions</code>\n"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of additional data to include in the response.<br>\n<b>Allowed value</b>: \n<ul>\n  <li><code>last_message_info</code>: Includes details of the last message in the chat, such as message ID, sender, timestamp, content preview, and message type.</li>\n</ul>\nBy default, last message information is not returned. Specify <code>include=last_message_info</code> to include it in the response.<br>\n<b>Example</b>: <code>https://cliq.zoho.com/api/v3/chats/{CHAT_ID}?include=last_message_info</code>\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieve details of a specific chat by its unique identifier. You can specify optional fields to include in the response for more efficient data retrieval.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 60 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 5 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"th"
        },
        {
          "info": {
            "name": "Update chat title or history status",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Modify a chat's title or history status. Only one operation can be performed per request.<br><br>\n<b>Supported operations:</b><br>\n<ul>\n  <li><code>update_title</code>: Updates the <b>visible title of the chat</b>. Pass the new title in the <code>title</code> field.<br>\n  <li><code>update_history_status</code> : Controls whether <b>chat history is retained</b>. Set <code>history_status</code> to <code>enabled</code> or <code>disabled</code>.<br>\n</ul>\n<br>\n<p>\n  <b>Threshold limits</b>:<br>\n  <c"
        },
        {
          "info": {
            "name": "Update Chat Read or Unread Status",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID1",
            "params": [
              {
                "name": "CHAT_ID1",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. Accepts the same chat ID format as CHAT_ID. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page.<br><br> \n<b>Note:</b> <code>CHAT_ID1</code> is a documentation alias for <code>CHAT_ID</code>, used to separate the \"Update Chat Read or Unread Status\" operation for better readability while sharing the same <code>/chats/{CHAT_ID}</code> endpoint.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Marks a single chat as read or unread for the calling user.<br><br>\n<b>Supported operations:</b><br>\n<ul>\n  <li><code>mark_as_read</code>: <b>Marks the chat as read</b> up to a specific message. Pass the <code>last_message_id</code> of the chat till to be read.</li>\n  <li><code>mark_as_unread</code>: <b>Marks the chat as unread</b> from a specific message. Pass the target <code>message_id</code>.</li>\n</ul>\n<br>\n<p>\n  <b>Threshold limit</b>: 60 requests per min<br>\n  Number of API calls allowed "
        },
        {
          "info": {
            "name": "Clear Local Chat History",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID2",
            "params": [
              {
                "name": "CHAT_ID2",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page.\n<br><br>\n<b>Note:</b> <code>CHAT_ID2</code> is a documentation alias for <code>CHAT_ID</code>, used to separate the \"Clear Local Chat History\" operation for better readability while sharing the same <code>/chats/{CHAT_ID}</code> endpoint.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Clears the local message history of a chat for the current user. The chat itself and all members remain intact; only the locally visible message history is cleared.\nOnly supported for direct messages and group chats.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 60 requests per min<br>\n  Number of API calls allowed within a minute.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint"
        },
        {
          "info": {
            "name": "Close a chat",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID3",
            "params": [
              {
                "name": "CHAT_ID3",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. Accepts the same chat ID format as CHAT_ID. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page.<br><br>\n<b>Note:</b> <code>CHAT_ID3</code> is a documentation alias for <code>CHAT_ID</code>, used to separate the \"Close a chat\" operation for better readability while sharing the same <code>/chats/{CHAT_ID}</code> endpoint.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Closes a chat by removing it from the recent chats list of the user. The chat will still be accessible through search and other means, all members remain intact and only the visibility in recent chats is affected.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 60 requests per min<br>\n  Number of API calls allowed within a minute.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint')."
        },
        {
          "info": {
            "name": "Retrieve members of a chat",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/members",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Use this parameter to get details of members participating in the chat.<br>\n<b>Allowed values</b>:\n<ul>\n  <li><b>user_id</b> - Unique identifier for the user in Cliq.</li>\n  <li><b>email_id</b> - Email address of the user.</li>\n  <li><b>name</b> - Display name of the user.</li>\n</ul>\n<br><br>\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Use this API to retrieve the list of members participating in a channel or group chat.\n<br><br>\nCommon use cases:\n<ul>\n  <li>Render a participant panel for a channel or group chat in your app UI.</li>\n  <li>Show participant identity fields (name, email_id, user_id) using the <code>fields</code> query parameter.</li>\n  <li>Audit chat membership before running automations or sending targeted messages.</li>\n</ul>\n<br><br>\n<p>\n  <b>Threshold limit</b>: 20 requests per min per user<br>\n  Number of AP"
        },
        {
          "info": {
            "name": "Add members to a chat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/members",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Adds one or more users to an existing group chat.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 20 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint').textContent=this.open?'Click to collapse':'Click to expand'\">\n  <sum"
        },
        {
          "info": {
            "name": "Remove members from a chat",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/members",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              },
              {
                "name": "user_ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user IDs to remove."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Removes one or more users from an existing group chat.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 20 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint').textContent=this.open?'Click to collapse':'Click to expand'\">\n "
        },
        {
          "info": {
            "name": "Fork a chat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/forks",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the source chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Fork chats help you start a new conversation from an existing one (1-1, Group Chat, Channel). You can choose how many users you want to share the chat with and from which point you want to share it.\n<br><br>With this API , you can create a new chat with a selected set of messages from the original chat. This is useful when you want to start a new discussion based on a specific topic or context from an existing chat, without sharing the entire chat history.\n<br><br>\n<p>\n  <b>Threshold limit</b>: "
        },
        {
          "info": {
            "name": "Send Typing Indicator",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/activities",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Sends a typing indicator activity to a chat, signaling that the user is currently typing a message.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 100 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 50 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint').textContent=this."
        },
        {
          "info": {
            "name": "Leave a chat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/leave",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat that you wish to leave. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Use this API to remove the authenticated user from a group chat or channel.\nAfter leaving, the user is no longer an active participant in that chat.\n<br><br>\nThis endpoint is helpful for exiting discussions that are no longer relevant to the user.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 20 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n"
        },
        {
          "info": {
            "name": "Mute a chat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/mute",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat that needs to be muted. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Use this API to mute notifications for any given chat while still keeping it accessible.\nMuting is ideal for high-volume group chats or channels where the user wants to stay in the conversation but avoid constant notification interruptions.\n<br><br>\nThis setting affects chat-level notifications and helps keep conversations organized without leaving them entirely.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 20 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lo"
        },
        {
          "info": {
            "name": "Unmute a chat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/unmute",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the chat that needs to be unmuted. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Use this API to restore notifications for any given previously muted chat.\nOnce unmuted, the user starts receiving chat updates again according to their notification settings.\n<br><br>\nUse this when a group chat or channel becomes active or relevant again and timely visibility of messages is required.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 20 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API r"
        },
        {
          "info": {
            "name": "Mentioning available users in a Channel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID4/messages",
            "params": [
              {
                "name": "CHAT_ID4",
                "value": "CHAT_ID",
                "type": "path",
                "description": "Unique identifier of the chat where the message needs to be sent. To learn how to retrieve this ID, see <a href=\"/cliq/help/restapi/v3/glossary/#CHAT_ID\">CHAT_ID</a> in the Glossary page.<br><br>\n<b>Note:</b> <code>CHAT_ID4</code> is a documentation alias for <code>CHAT_ID</code>, used to document the \"Mentioning available users in a Channel\" use case separately while sharing the same <code>/chats/{CHAT_ID}/messages</code> endpoint, since the path is unchanged and only the message content pattern differs.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "To mention all users who are currently available in a channel, use the syntax {@available}.<br><br>\nThis will notify only the participants whose status is set to Available at the time the message is posted.\n"
        },
        {
          "info": {
            "name": "Retrieve thread details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/threads/:THREAD_CHAT_ID",
            "params": [
              {
                "name": "THREAD_CHAT_ID",
                "value": "THREAD_CHAT_ID",
                "type": "path",
                "description": "The unique identifier of the thread chat."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Fetches details of a thread using its thread chat ID. Returns information such as the thread title, follower count, whether the requesting user is a follower, the parent chat, and the thread's open/closed state.\n<br><br>\n<p>\n  <b>Threshold limit</b>: 20 requests per min per user<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 5 minutes<br>Wait time before consecutive API requests.<br>\n</p>\n<details style=\"margin:16px 0 8px 0; border:1px solid rgba(148,163,184,0.5"
        }
      ]
    }
  ],
  "bundled": true
}