Zoho Cliq icon

Zoho Cliq

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

Actions168

Chat → Pin Message

AI-generated

Summary

Pins a specific message as sticky in a Zoho Cliq chat using the message's ID.

Inputs

  • Chat ID (required) — The Zoho Cliq chat ID (e.g., CT1234567890) where the message resides. Not a channel ID.
  • Message ID (required) — The message ID (msguid) of the message to pin. Encoded IDs like 1573708648341%20375412769224 are accepted.
  • Pin Options — Optional collection. Include 'Notify' to notify participants or 'Expire At' to set a future expiry time for the pinned message.
  • Enable AI Error Mode — If true, errors are returned as output items (continue-on-fail) instead of stopping execution.
  • Include Enhanced Output — If true, returns workflow-friendly metadata alongside the API response.

Output shape

a single item with the API response data

The response shape depends on the 'Include Enhanced Output' setting. If disabled, only the standard Zoho Cliq pin response is returned.

Examples

Example 1: Pin a message in a public channel

Chat ID: CT1234567890, Message ID: 1573708648341_375412769224, Include Enhanced Output: true

Example 2: Pin a message and notify all participants

Chat ID: CT9876543210, Message ID: 1234567890, Pin Options: Notify = true

Example 3: Pin a message with a 7-day expiry

Chat ID: CT5555555555, Message ID: 9876543210, Pin Options: Expire At = 2024-12-31T00:00:00Z

Links

Discussion