Zoho CliqInstall

Summary

Fetches a list of users subscribed to a specified Zoho Cliq bot, supporting standard pagination and incremental sync via sync tokens.

Inputs

• enableAiErrorMode — Whether to return errors as output items instead of stopping execution. Recommended for AI Tool runs that should recover from API errors.
• botUniqueName (required) — Unique bot identifier from Cliq. Use the bot unique name, not bot display name or bot ID. Allowed characters: lowercase letters only (a-z).
• additionalFields.appkey — Extension app key string. Required only when the selected bot belongs to an extension app; leave empty for regular bots.
• additionalFields.limit — Max number of results to return. Optional page size (limit). Use a whole number from 1 to 100.
• additionalFields.nextToken — Opaque pagination token from a previous subscribers response (next_token). Use for standard pagination and provide exactly as returned. Do not combine with Sync Token.
• additionalFields.syncToken — Opaque sync token from a previous subscribers response (sync_token) to fetch only newly subscribed users since the last sync point. Use this token alone (without Next Token).

Output shape

a list of items, each containing subscriber details.

Supports pagination via Next Token. Can also use Sync Token for incremental updates. Requires the ZohoCliq.Bots.READ scope.

Examples

Example 1: Fetch the first 50 subscribers of a bot named 'sales-support-bot'.

Bot Unique Name: sales-support-bot, Additional Fields > Limit: 50

Example 2: Retrieve newly subscribed users since the last sync using a sync token.

Bot Unique Name: sales-support-bot, Additional Fields > Sync Token: [previous_sync_token]

Example 3: Continue execution on API errors for an AI Tool workflow.

Enable AI Error Mode: true, Bot Unique Name: sales-support-bot

Links

• n8n community nodes installation guide