Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zoho Cliq

Zoho Cliq chats API

Chats Module

Documentation Provider Profile APIs.io OpenAPI GitHub

Zoho Cliq chats API is one of 22 APIs that Zoho Cliq publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include chats. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 4 JSON Schemas.

This API exposes 19 operations across 14 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://cliq.zoho.com/api/v3.

19 operations 14 paths 11 schemas 1 DELETE5 GET8 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://cliq.zoho.com/api/v3
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Cliq chats API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 1 DELETE, 5 GET, 8 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

chats 19

Chats Module

GET
/chats
Retrieve all direct chats
Retrieve all direct chats 13 params → 200400401403404405406429
POST
/chats
Create chat
createChatV3 body → 200400401403429500
PUT
/chats
Mark Multiple Chats as Read or Clear Unread Count
bulkUpdateChatsV3 body → 200400401403429500
GET
/chats/search
Search chats
searchChatsV3 8 params → 200400401403429500
GET
/chats/{CHAT_ID}
Retrieve chat details
getChatV3 3 params → 200400401403404429500
PUT
/chats/{CHAT_ID}
Update chat title or history status
updateChatV3 1 param body → 200204400401403404429500
PUT
/chats/{CHAT_ID1}
Update Chat Read or Unread Status
markChatAsUnreadV3 1 param body → 204400401403429500
PUT
/chats/{CHAT_ID2}
Clear Local Chat History
clearChatMessagesV3 1 param body → 204400401403429500
PUT
/chats/{CHAT_ID3}
Close a chat
closeChatV3 1 param body → 204400401403429500
GET
/chats/{CHAT_ID}/members
Retrieve members of a chat
Retrieve members of a chat 2 params → 200400401403404429500
POST
/chats/{CHAT_ID}/members
Add members to a chat
addMembersToChatV3 1 param body → 200400401403429500503
DELETE
/chats/{CHAT_ID}/members
Remove members from a chat
removeMembersFromChatV3 2 params → 200400401403429500503
POST
/chats/{CHAT_ID}/forks
Fork a chat
forkChatV3 1 param body → 200400401403429500
POST
/chats/{CHAT_ID}/activities
Send Typing Indicator
sendTypingActivityV3 1 param body → 204400401403429500
POST
/chats/{CHAT_ID}/leave
Leave a chat
Leave a chat 1 param → 200400401403429500
POST
/chats/{CHAT_ID}/mute
Mute a chat
Mute a chat 1 param → 200400401403429500
POST
/chats/{CHAT_ID}/unmute
Unmute a chat
Unmute a chat 1 param → 200400401403429500
POST
/chats/{CHAT_ID4}/messages
Mentioning available users in a Channel
mentioningAvailableUsers 1 param body → 200400401403404405406429
GET
/threads/{THREAD_CHAT_ID}
Retrieve thread details
getThreadDetailsV3 1 param → 200400401403429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are v3-chat (15 properties), v3-thread (9 properties), v3-bulk-chat-update-request (4 properties), v3-fork-chat-request (4 properties). Each schema is shown below with its type and property counts.

retrieve-chat-members
object
Response object containing members of a chat.
1 property
v3-chat
object
Represents a chat object with comprehensive details including metadata, participants, and message information.
15 properties
v3-thread
object
9 properties
v3-fork-chat-request
object
4 properties 2 required
v3-typing-activity-request
object
1 property 1 required
empty-response
object
Response returned when there is no content.
1 property
v3-create-chat-request
object
For direct chat, send chattype: directmessage with userid. For group chat, send chattype: groupchat with userids and title.
4 properties 1 required
NoResponse
object
Response object returned when no content is available.
1 property
v3-add-members-request
object
1 property 1 required
v3-bulk-chat-update-request
object
Supports two payload modes, selected by the operation field: Mark as read ( readstatusupdate ): Set operation to readstatusupdate , readstatus to read , and pr…
4 properties 1 required
Members
object
Detailed information about a chat member.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-cliq-chats-api-openapi.yml Raw ↑

Other APIs Zoho Cliq publishes across the network.

Zoho Cliq Bots API
AE Profile APIs.io
Zoho Cliq buttons API
AE Profile APIs.io
Zoho Cliq dndsettings API
AE Profile APIs.io
Zoho Cliq Extensions API
AE Profile APIs.io
Zoho Cliq Functions API
AE Profile APIs.io
Zoho Cliq keyboardshortcuts API
AE Profile APIs.io
Zoho Cliq mentions API
AE Profile APIs.io
Zoho Cliq messageactions API
AE Profile APIs.io
Zoho Cliq messagecards API
AE Profile APIs.io
Zoho Cliq messageformat API
AE Profile APIs.io
Zoho Cliq messages API
AE Profile APIs.io
Zoho Cliq mobilesettings API
AE Profile APIs.io
#chats
← Back to Z APIs
API Details
ID
zoho-cliq:zoho-cliq-chats-api
Base URL
https://cliq.zoho.com/api/v3
Docs
https://www.zoho.com/cliq/help/restapi/v3/introduction/
Provider
Zoho Cliq
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network