Zoho Cliq icon

Zoho Cliq

Fully manage your Zoho Cliq workspace: messages, channels, teams, users, databases, events, reminders, bots, files, and more

Actions168

Chat → Get Pinned Message

AI-generated

Summary

Retrieves the pinned sticky message for a specified Zoho Cliq chat.

Inputs

  • Chat ID (required) — Required Zoho Cliq chat ID for the conversation whose pinned message you want to retrieve. This is not a channel ID. Chat IDs may be all-numeric for some direct/private chats or use a CT_... style in other chat contexts. Do not pass a channel_id, channel unique name, or display name.
  • Enable AI Error Mode — Whether to return errors as output items (continue-on-fail style) instead of stopping execution. Recommended for AI Tool runs that should recover from API errors.

Output shape

A list of items, each containing the pinned sticky message details.

If no pinned message exists, the operation returns an empty list. The output shape follows the node's standard response structure, which includes the message details.

Examples

Example 1: Retrieve the pinned message from a direct chat with ID CT1234567890.

Chat ID: CT1234567890 (required), Enable AI Error Mode: false (default)

Example 2: Fetch the pinned message for a private chat using a numeric ID.

Chat ID: 1234567890 (required), Enable AI Error Mode: true (to recover from errors)

Links

Discussion