What's new in v3?

Rich chats and message operations

• v3 completes the chat and message capabilities that were left unfinished in v2.
• Create direct/group chats, perform advanced searches, fork chats from messages, bulk-update read states, create chat folders, and manage pinned/starred messages.

Uniform pagination across all modules

• v2 used six different pagination tokens: next_token, sync_token, next_set_token, start_token, next_search_token, and page_number.
• v3 standardizes this with only next_token for paging and sync_token for incremental synchronization across all modules.

Platform component development via APIs

• v3 introduces CRUD API endpoints for bots, slash commands, message actions, widgets, schedulers, and more, which were not available in v2.
• You get full programmatic control over CRUD operations and handler lifecycle management, enabling scripted and version-controlled developer workflows.

Customizations

• v3 consolidates customization-related endpoints under /api/v3/settings with a consistent input type pattern.
• Use APIs for keyboard shortcuts, Do Not Disturb (DND) preferences, mobile settings, and user preferences.

Authentication

Zoho Cliq API uses the OAuth 2.0 protocol for authentication. OAuth 2.0 is an industry-standard protocol specification that enables third-party applications (also known as clients) to gain delegated access to protected resources in Zoho Cliq via an API.

OAuth 2.0 is an industry-standard protocol that allows you to grant a third-party website or application (i.e., a client) delegated access to Zoho Cliq's protected resources via Zoho Cliq APIs. It is a way to authenticate and authorise API requests made to Zoho Cliq.

• Clients are not required to support password authentication or store user credentials, as authentication and authorisation are handled by exchanging OAuth tokens.
• Clients gain delegated access, i.e., access only to resources authorised by the user.
• Users can revoke a third-party application's delegated access at any time.
• OAuth access tokens expire after a set time. If the client faces a security breach, user data will be compromised only as long as the access token remains valid.

Networks

Cliq network is a dedicated space for collaborating with external business stakeholders such as partners, vendors, agencies, consultants, volunteers, and more. It equips you with an extensive set of configurable permissions to facilitate controlled, secure, and full-fledged external collaboration.

In the case of networks, the API Root endpoint differs. All the network endpoints should have the prefix as /network/{NETWORK_UNIQUE_NAME} or /network/{NETWORK_ID}

For example, the API Root endpoints to call information from a Cliq network named 'Zylker Clients' would be:

https://cliq.zoho.com/network/zylkerclients

zylkerclients is the unique name of the network.

Multiple Data Centers

Zoho Cliq is hosted at multiple data centers, and therefore available on different domains.

There are 9 different domains for Zoho Cliq's APIs, so you can use the one that is applicable to you.

The APIs on this page are for organizations hosted on the .com domain. If your organization is on a different domain, replace ".com" with the appropriate domain for the API endpoints on this page before using them.