{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bots pinmessages API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "pinmessages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get pinned messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/pin-messages",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "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": "primary",
                "value": "",
                "type": "query",
                "description": "Pass this parameter (no value needed) to fetch the primary pinned message instead of the full list."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of pinned messages to return.\n<br>Defaults to 20 if not specified.\n"
              },
              {
                "name": "next_token",
                "value": "",
                "type": "query",
                "description": "Token from a previous response to fetch the next page of results. Omit to fetch the first page.\n"
              },
              {
                "name": "sync_token",
                "value": "",
                "type": "query",
                "description": "Synchronization token for incremental sync of pinned messages.<br>\nPass the <code>sync_token</code> received in an earlier response to fetch only updates after that sync point.<br>\n<b>Format</b>: base64 token.<br>\n<b>Maximum length</b>: 100 characters.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Returns the list of pinned messages in a chat, sorted by pin time with the most recent first. Optionally, you can fetch only the <b>primary pinned message</b> or use <b>pagination</b> for efficient retrieval.\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); border-ra"
        },
        {
          "info": {
            "name": "Add a pinned message",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/pin-messages",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "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": "Pins a message in a chat.\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); 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; paddin"
        },
        {
          "info": {
            "name": "Reorder pinned messages",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/pin-messages",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "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": "Changes the position of a pinned message in the list. If the message is reordered above the current primary pin, it automatically becomes the new primary.\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); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySe"
        },
        {
          "info": {
            "name": "Delete pinned messages",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/pin-messages",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "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": "Removes one or more pinned messages from a chat.\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); border-radius:8px; font-family:inherit;\" ontoggle=\"this.querySelector('.err-toggle-hint').textContent=this.open?'Click to collapse':'Click to expand'\">\n  <summary style="
        },
        {
          "info": {
            "name": "Get primary pinned message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cliq.zoho.com/api/v3/chats/:CHAT_ID/pin-messages?primary=true",
            "params": [
              {
                "name": "CHAT_ID",
                "value": "CHAT_ID",
                "type": "path",
                "description": "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"
              },
              {
                "name": "primary",
                "value": "true",
                "type": "query",
                "description": "Pass this parameter without a value to retrieve only the primary pinned message of the chat, instead of the full list of pinned messages.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Fetches the primary pinned message in a chat. The primary pin is the most prominently displayed pinned message, typically shown at the top of the pinned list and highlighted in the UI.\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); border-radius:8px; font-family:in"
        }
      ]
    }
  ],
  "bundled": true
}