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

Zoho Cliq threads API

Threads Module

Zoho Cliq threads 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 threads. 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 16 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.

16 operations 14 paths 11 schemas 1 DELETE4 GET10 POST1 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 threads API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.

Paths & Operations 16

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

threads 16

Threads Module

POST
/channels/{CHANNEL_ID}/messages
Create and send a thread message with CHANNELID
createThreadMessageByChannelId 2 params body → 200400401403404405406429
POST
/chats/{CHAT_ID}/messages
Create and send a thread message with CHATID
createThreadMessageByChatId 2 params body → 200400401403404405406429
POST
/channelsbyname/{CHANNEL_UNIQUE_NAME}/messages
Create and send a thread message with CHANNELUNIQUENAME
createThreadMessageByChannelUniqueName 2 params body → 200400401403404405406429
POST
/chats/{THREAD_CHAT_ID}/messages
Send a message to an existing thread
Send a message to an existing thread 2 params body → 200400401403404405406429
PUT
/threads/{THREAD_CHAT_ID}
Update the state of a thread
Update the state of a thread 3 params body → 204400401403404405406429
GET
/threads/{THREAD_CHAT_ID}/messages/main
Get main message of a thread
Get main message of a thread 1 param → 200400401403404405406429
GET
/threads/{THREAD_CHAT_ID}/followers
Get thread followers
Get thread followers 1 param → 200400401403404405406429
POST
/threads/{THREAD_CHAT_ID}/followers
Add followers to a thread
Add followers to a thread 1 param body → 204400401403404405406429
DELETE
/threads/{THREAD_CHAT_ID}/followers
Remove followers from a thread
Remove followers from a thread 1 param body → 204400401403404405406429
GET
/threads/{THREAD_CHAT_ID}/nonfollowers
Get non-followers of a thread
Get non-followers of a thread 1 param → 200400401403404405406429
POST
/threads/{THREAD_CHAT_ID}/follow
Join (follow) a thread
Join-follow a thread 1 param → 204400401403404405406429
POST
/threads/{THREAD_CHAT_ID}/unfollow
Leave (unfollow) a thread
Leave-unfollow a thread 1 param → 204400401403404405406429
GET
/chats/{THREAD_CHAT_ID}/members
Retrieve members of a thread
Retrieve members of a thread 2 params → 200400401403404405406429
POST
/chats/{THREAD_CHAT_ID}/leave
Leave a thread
Leave a thread 1 param → 200400401403404405406429
POST
/chats/{THREAD_CHAT_ID}/mute
Mute a thread
Mute a thread 1 param → 200400401403404405406429
POST
/chats/{THREAD_CHAT_ID}/unmute
Unmute a thread
Unmute a thread 1 param → 200400401403404405406429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are get-main-message-response (10 properties), thread-creation-payload (6 properties), send-message-in-thread-payload (4 properties), Members (3 properties). Each schema is shown below with its type and property counts.

send-message-in-thread-payload
object
Request body to send a message in an existing thread.
4 properties 1 required
retrieve-chat-members
object
Response object containing members of a chat.
1 property
thread-creation-response
object
Response returned after creating a thread.
1 property
no-response
object
Response object returned when no content is available.
1 property
get-main-message-response
object
Response containing the details of a main message and its thread information.
10 properties
add-followers-payload
object
Request body to add followers to a thread.
1 property 1 required
thread-creation-payload
object
Request body to create a new thread from an existing message.
6 properties 2 required
get-thread-followers-response
object
Response containing the list of followers for a particular thread.
1 property
update-state-of-thread-request
object
Request body to update the state of a thread (open or closed).
1 property 1 required
remove-followers-payload
object
Request body to remove followers from a thread.
1 property 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-threads-api-openapi.yml Raw ↑

Other APIs Zoho Cliq publishes across the network.

Zoho Cliq Bots API
Zoho Cliq buttons API
Zoho Cliq chats API
Zoho Cliq dndsettings API
Zoho Cliq Extensions API
Zoho Cliq Functions API
Zoho Cliq keyboardshortcuts API
Zoho Cliq mentions API
Zoho Cliq messageactions API
Zoho Cliq messagecards API
Zoho Cliq messageformat API
Zoho Cliq messages API