Actions168
- Bot Actions
- Call & Meeting Actions
- Channel Actions
- Add Bot to Channel
- Add Channel Members
- Approve Channel
- Archive Channel
- Change Channel Member Role
- Change Channel Permission
- Create Channel
- Delete Channel
- Get Channel
- Get Channel Members
- Join Channel
- Leave Channel
- List Channels
- Reject Channel
- Remove Bot From Channel
- Remove Channel Members
- Remove Single Channel Member
- Unarchive Channel
- Update Channel
- Chat Actions
- Cliq Database Actions
- Custom Domain Actions
- Custom Email Actions
- Department Actions
- Designation Actions
- Event Actions
- File Actions
- Maintenance (Bulk Export) Actions
- Message Actions
- Message Component Builder Actions
- OAuth Helper Actions
- Reaction Actions
- Reminder Actions
- Remote Work Actions
- Role Actions
- Team Actions
- Thread Actions
- User Actions
- User Field Actions
- User Status Actions
- Widget Map Ticker Actions
Chat → Pin Message
AI-generatedSummary
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%20375412769224are 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