Zoho CliqInstall

Summary

Send messages to various targets within Zoho Cliq, including bots, channels, chats, threads, or direct users, with options for message formats such as text, rich cards, or raw JSON payloads, and configure message details like mentions, buttons, and attachments.

Inputs

• target (required) — Select where to send the message: bot, channel, chat, thread, user, or allow AI agent to choose (Agent's Choice).
• agentSelectedTarget (required) — When using Agent's Choice target, specify the target family such as bot, channel by ID or unique name, chat, thread, or user.
• channelId (required) — For sending to a channel, select or provide the channel's ID or unique name.
• botUniqueName — Provide the exact bot unique name when sending as a bot or posting as a bot to a channel or chat.
• chatId (required) — Specify the chat ID when sending a message to a chat.
• postToThread — For chat targets, optionally post the message in a specific thread under the chat.
• threadId — If posting to a thread under a chat, specify the thread ID.
• threadChatId (required) — Required when target is thread: the chat ID that contains the target thread (may include channel chat IDs).
• threadTargetId (required) — Required when target is thread: the thread ID combined with Thread Chat ID to specify the target thread.
• emailOrZuid (required) — When sending a direct message to a user, provide the user's email address or ZUID.
• broadcast — When sending via a bot, optionally send the message to all subscribers of the bot.
• userIds — When sending via a bot and not broadcasting, specify a comma-separated list of user IDs (subscribers) to receive the message.
• postAsBot — Optionally post the message as a bot for applicable target types.
• botDisplayName — Optional display name for the bot when posting as a bot.
• botImage — Optional image URL for the bot when posting as a bot.
• messageType (required) — Choose the message format: text (Cliq Markdown), rich card, or advanced raw JSON payload.
• text — When using text message type, provide the message content in Cliq Markdown format (up to 5000 characters).
• addMention — Optionally add guided mention tokens to the text message.
• mentions — Configure specific mentions like all participants, available users, silent users, teams, or specific users using IDs or emails.
• attachComponentPayloads — When sending text messages, optionally attach component payloads such as slides or buttons created by builder operations.
• attachedSlides — Array of slide component objects to include as payload slides.
• attachedButtons — Array of button objects to include as payload buttons.
• cardInputMode — For rich message type, choose how to provide card content: raw JSON or structured fields.
• cardTheme — Select the card theme when using structured input mode for rich cards.
• cardTitle — Optional title for the card when using structured input mode.
• richPayloadJson — Raw JSON object representing the full rich message payload when using raw JSON mode for rich cards.
• richText — Top-level card text included in the rich message payload (max 4096 characters).
• addCardIcon — Optionally add a small icon to the card.
• cardIconInputMode — Choose between Iconify prefix/icon or custom URL for the card icon.
• cardIconIconify — Iconify prefix/icon value for the card icon.
• cardIcon — Custom HTTPS URL for the card icon image.
• addCardThumbnail — Optionally add a large thumbnail image to the card.
• cardThumbnailInputMode — Choose between Iconify prefix/icon or custom URL for the card thumbnail.
• cardThumbnailIconify — Iconify prefix/icon value for the card thumbnail.
• cardThumbnail — Custom HTTPS URL for the card thumbnail image.
• slides — Collection of components such as charts, graphs, images, labels, lists, tables, or texts for the card slide content.
• buttons — Buttons shown at the bottom of the card with customizable labels, actions, and confirmations.
• jsonBody — When using Advanced (JSON) message type, provide a raw JSON object with required text and other message structure.
• optionalFields — Optional fields to apply such as marking the message as read, replying to a specific message ID, or requesting synchronous response with message metadata.
• includeEnhancedOutput — When posting to a channel, optionally append workflow-friendly metadata about the posted channel and message.
• enableAiErrorMode — Configure whether errors are returned as output items (continue-on-fail style) to allow AI tools to handle API errors gracefully.

Output shape

a list of message post response objects, potentially including created message metadata and enhanced channel info if requested

Supports including detailed message metadata with sync message option. Errors can be returned as output items if AI error mode is enabled, otherwise execution is stopped on errors.

Links

• n8n community nodes installation guide