{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bots Stars API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Stars",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List starred messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/stars",
            "params": [
              {
                "name": "chat_id",
                "value": "",
                "type": "query",
                "description": "Filter starred messages to only include those from a specific chat. Provide the chat ID in the format \"2000000012345_2000000067890\". If omitted, starred messages from all chats will be included.\n"
              },
              {
                "name": "star_type",
                "value": "",
                "type": "query",
                "description": "Filter starred messages by a specific star type.\n  <br><br>\n  <b>Allowed values:</b><br>\n  <ul>\n    <li><code>important</code>: Mark messages that require special attention or contain critical information.</li>\n    <li><code>to_do</code>: Flag messages representing tasks or action items that need to be completed.</li>\n    <li><code>note</code>: Save messages for future reference or as reminders of important information.</li>\n    <li><code>manager</code>: Highlight messages related to managerial communications or approvals.</li>\n    <li><code>follow_up</code>: Identify messages that require follow-up actions or responses.</li>\n    <li><code>all</code>: Retrieve all starred messages regardless of star type.</li>\n  </ul>\n"
              },
              {
                "name": "from_time",
                "value": "",
                "type": "query",
                "description": "<ul>\n<li>Lower bound timestamp for message time.</li>\n<li>Accepts epoch milliseconds (for example, <code>1704067200000</code>) or <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> datetime strings (for example, <code>2024-01-01T00:00:00Z</code>).</li>\n<li>Only messages starred after this time will be included in the results.</li>\n<li>If omitted, there is no lower time limit on the messages returned.</li>\n</ul>\n"
              },
              {
                "name": "to_time",
                "value": "",
                "type": "query",
                "description": "<ul>\n<li>Upper bound timestamp for message time.</li>\n<li>Accepts epoch milliseconds (for example, <code>1735689599999</code>) or <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> datetime strings (for example, <code>2024-12-31T23:59:59Z</code>).</li>\n<li>Only messages starred before this time will be included in the results.</li>\n<li>If omitted, there is no upper time limit on the messages returned.</li>\n</ul>\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of starred messages to return in the response.<br>\n<b>Maximum limit</b>:50<br>\n<b>Default</b>:50<br>\nIf the total number of starred messages exceeds this limit, a pagination token will be included in the response to retrieve the next page of results.\n"
              },
              {
                "name": "next_token",
                "value": "",
                "type": "query",
                "description": "Opaque pagination token to retrieve the next page of results.\n<ul>\n  <li>This token is provided in the response when there are more results available than can fit in a single response.</li>\n  <li>To retrieve the next page, include this token in the subsequent request without modifying it.</li>\n  <li>The token is base64-encoded.</li>\n  <li>If omitted, the first page of results will be returned.</li>\n</ul>\n"
              },
              {
                "name": "sync_token",
                "value": "",
                "type": "query",
                "description": "Synchronization token for incremental updates.\n<ul>\n  <li>This token is returned in the response to help clients sync local state.</li>\n  <li>When provided in a request, only starred message changes after that sync point are returned.</li>\n  <li>If omitted, results are returned based on the other filters.</li>\n  <li><b>Format</b>: base64 token.</li>\n  <li><b>Maximum length</b>: 200 characters.</li>\n</ul>\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieves the authenticated user's starred messages with support for advanced filtering, cursor-based pagination, and incremental synchronization.\n<br><br>\nThis endpoint allows you to filter starred messages by chat, star type, and time range. Use pagination tokens to navigate through large result sets efficiently.\n<br><br>\n<p>\n  <b>OAuth Scope</b>: Messages<br>\n  <b>Threshold limit</b>: 30 requests per min<br>\n  Number of API calls allowed within a minute.<br><br>\n  <b>Lock period</b>: 5 minute"
        },
        {
          "info": {
            "name": "Star a Message or Update Star Type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/stars",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Stars a message with a specific star type. This enables users to categorize messages for easier retrieval and workflow management. Each message can have only one active star type at a time.\n<br><br>\nIf the message is already starred, this operation updates the existing star type to the newly specified type and hence no separate update call is needed. \nWhen the star type is updated, the response includes <code>star_information.old_star_type</code> indicating the previous star type.\n<br><br>\n<p>\n "
        },
        {
          "info": {
            "name": "Unstar a Message",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cliq.zoho.com/api/v3/stars/:MESSAGE_ID",
            "params": [
              {
                "name": "MESSAGE_ID",
                "value": "MESSAGE_ID",
                "type": "path",
                "description": "The unique identifier of the message to be unstarred.<br>\nUse the <a href=\"/cliq/help/restapi/v3/stars/#list-starred-messages\">Retrieve Starred Messages</a> endpoint to get the message IDs of starred messages.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Removes the star from a specified message. This operation permanently deletes the star record for the authenticated user.\n<br><br>\nIf the message is not currently starred by the user, an error will be returned.\n<br><br>\n<p>\n  <b>OAuth Scope</b>: Messages<br>\n  <b>Threshold limit</b>: 50 requests per min<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 after exceeding the threshold.<br>\n</p>\n<details style=\"mar"
        }
      ]
    }
  ],
  "bundled": true
}