Zoho Cliq · Example Payload
Chats
MessagingTeam CollaborationChatBotsWebhooksSlash CommandsCommunication
Chats is an example object payload from Zoho Cliq, with 13 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
Retrieve all direct chatscreateChatV3bulkUpdateChatsV3searchChatsV3getChatV3updateChatV3markChatAsUnreadV3clearChatMessagesV3closeChatV3addMembersToChatV3removeMembersFromChatV3forkChatV3sendTypingActivityV3
Example Payload
{
"Retrieve all direct chats": {
"path": "/chats",
"method": "get",
"examples": {
"response_200": {
"success": {
"summary": "List of direct chats",
"value": {
"chats": [
{
"chat_id": "2890538000000012345",
"name": "Alice Johnson",
"chat_type": "direct_message",
"participant_count": 2,
"created_time": "2024-06-01T09:00:00.000Z",
"last_modified_time": "2025-04-10T14:30:00.000Z",
"pinned": false,
"removed": false,
"creator": {
"id": "70027934",
"name": "Tim Harrison"
},
"last_message_info": {
"message_id": "1773813859592_51531973059",
"sender": "70027934",
"time": "2025-04-10T14:30:00.000Z",
"content": {
"text": "See you at the standup!"
},
"type": "text"
}
},
{
"chat_id": "2890538000000067890",
"name": "Bob Carter",
"chat_type": "direct_message",
"participant_count": 2,
"created_time": "2024-09-15T11:00:00.000Z",
"last_modified_time": "2025-04-09T09:45:00.000Z",
"pinned": true,
"removed": false,
"creator": {
"id": "70027934",
"name": "Tim Harrison"
}
}
]
}
}
}
}
},
"createChatV3": {
"path": "/chats",
"method": "post",
"examples": {
"request": {
"direct_chat": {
"summary": "Direct Chat",
"value": {
"chat_type": "direct_message",
"user_id": "70027934"
}
},
"group_chat": {
"summary": "Group Chat",
"value": {
"chat_type": "group_chat",
"user_ids": [
"70027934",
"106324287",
"70317945",
"72589892"
],
"title": "Q2 Product Review - Design, Engineering & QA"
}
}
},
"response_200": {
"direct_chat": {
"summary": "Direct Chat response",
"value": {
"url": "/v3/chats",
"type": "chat",
"data": {
"user_membership": {
"pinned": false,
"removed": false
},
"chat_type": "direct_message",
"name": "Ryan West",
"creator": {
"name": "Ryan West",
"id": "855727963"
},
"participant_count": 2,
"created_time": "2024-11-06T22:39:30-08:00",
"last_modified_time": "2026-05-06T23:37:30-07:00",
"chat_id": "2198144177691461096"
}
}
},
"group_chat": {
"summary": "Group Chat response",
"value": {
"url": "/v3/chats",
"type": "chat",
"data": {
"name": "Q2 Product Review - Design, Engineering & QA",
"chat_id": "1456816193674892935",
"chat_type": "group_chat",
"participant_count": 5,
"created_time": "2025-06-15T10:30:00+05:30",
"last_modified_time": "2025-06-15T10:30:00+05:30",
"user_membership": {
"pinned": false,
"removed": false
},
"creator": {
"id": "70027934",
"name": "Tim Harrison"
}
}
}
}
}
}
},
"bulkUpdateChatsV3": {
"path": "/chats",
"method": "put",
"examples": {
"request": {
"read_status_update": {
"summary": "Mark multiple chats as read",
"value": {
"operation": "read_status_update",
"read_status": "read",
"chats": [
{
"chat_id": "2890538000000012345",
"last_message_id": "1773813859592_51531973059"
},
{
"chat_id": "2890538000000067890",
"last_message_id": "1773813860210_51531973060"
}
]
}
},
"clear_unread": {
"summary": "Clear unread count for multiple chats",
"value": {
"operation": "clear_unread",
"chat_ids": [
"2890538000000012345",
"2890538000000067890"
]
}
}
},
"response_200": {
"read_status_update": {
"summary": "Mark as read - success/failure breakdown",
"value": {
"type": "chat.read_status",
"data": {
"success": [
"2890538000000012345",
"2890538000000067890"
],
"failure": []
}
}
},
"clear_unread": {
"summary": "Clear unread count",
"value": {
"Response Code": "204 No response"
}
}
}
}
},
"searchChatsV3": {
"path": "/chats/search",
"method": "get",
"examples": {
"response_200": {
"multiple_chats": {
"summary": "Multiple chats found",
"value": {
"chats": [
{
"chat_id": "6795XXXXXXXXXXXXXX",
"name": "General",
"chat_type": "channel",
"participant_count": 42,
"created_time": "2024-01-10T09:00:00.000Z",
"last_modified_time": "2025-03-20T14:30:00.000Z",
"pinned": false,
"removed": false,
"creator": {
"id": "711622XXXX",
"name": "Alice"
},
"last_message_info": {
"message_id": "1710934200000",
"sender": "711622XXXX",
"time": "2025-03-20T14:30:00.000Z",
"content": {
"text": "Hello everyone!"
},
"type": "text"
}
},
{
"chat_id": "6795YYYYYYYYYYYY",
"name": "Bob",
"chat_type": "direct_message",
"participant_count": 2,
"created_time": "2024-06-01T10:00:00.000Z",
"last_modified_time": "2025-03-18T11:00:00.000Z",
"pinned": false,
"removed": false
}
]
}
}
},
"response_400": {
"invalid_inputs": {
"summary": "Invalid input parameters",
"value": {
"error": {
"code": "invalid.inputs.submitted",
"message": "An invalid value was passed. Please check chat_type or sort_by parameters."
}
}
},
"invalid_time": {
"summary": "Invalid timestamp",
"value": {
"error": {
"code": "invalid.time.submitted",
"message": "Invalid timestamp format or modified_after must be earlier than modified_before."
}
}
}
},
"response_401": {
"unauthorized": {
"summary": "Invalid auth token",
"value": {
"error": {
"code": "unauthorized",
"message": "Request was rejected because of invalid AuthToken."
}
}
}
},
"response_403": {
"invalid_access": {
"summary": "Access denied",
"value": {
"error": {
"code": "invalid_access",
"message": "You are not a member of this organisation or do not have permission to access this resource."
}
}
}
},
"response_429": {
"rate_limit": {
"summary": "Rate limit exceeded",
"value": {
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests within a certain time frame. Please try again later."
}
}
}
},
"response_500": {
"server_error": {
"summary": "Server error",
"value": {
"error": {
"code": "chat_operation_failed",
"message": "Cliq server encountered an error which prevents it from fulfilling the request."
}
}
}
}
}
},
"getChatV3": {
"path": "/chats/{CHAT_ID}",
"method": "get",
"examples": {
"response_200": {
"get_chat": {
"summary": "Chat details",
"value": {
"type": "chat",
"data": {
"chat_id": "2890538000000012345",
"name": "Q2 Product Review - Design, Engineering & QA",
"chat_type": "group_chat",
"participant_count": 5,
"created_time": "2025-06-15T10:30:00+05:30",
"last_modified_time": "2025-06-15T10:30:00+05:30",
"pinned": false,
"removed": false,
"creator": {
"id": "70027934",
"name": "Tim Harrison"
},
"unread_message_count": 3
}
}
},
"get_chat_with_last_message_info": {
"summary": "Chat details with last message info",
"value": {
"type": "chat",
"data": {
"chat_id": "2890538000000012345",
"name": "Q2 Product Review - Design, Engineering & QA",
"chat_type": "group_chat",
"participant_count": 5,
"created_time": "2025-06-15T10:30:00+05:30",
"last_modified_time": "2025-06-15T10:30:00+05:30",
"pinned": false,
"removed": false,
"creator": {
"id": "70027934",
"name": "Tim Harrison"
},
"unread_message_count": 3,
"last_message_info": {
"message_id": "1773813859592_51531973059",
"sender": "70027934",
"time": "2025-06-15T10:30:00+05:30",
"content": {
"text": "Let's sync up before the review."
},
"type": "text"
}
}
}
}
}
}
},
"updateChatV3": {
"path": "/chats/{CHAT_ID}",
"method": "put",
"examples": {
"request": {
"update_title": {
"summary": "Update chat title",
"value": {
"operation": "update_title",
"title": "Quarterly Rewards"
}
},
"update_history_status": {
"summary": "Update history status",
"value": {
"operation": "update_history_status",
"history_status": "enabled"
}
}
},
"response_200": {
"update_title": {
"summary": "Title updated successfully",
"value": {
"type": "chat.title",
"data": {
"title": "Quarterly Rewards",
"chat_id": "1424358626334691820"
}
}
},
"update_history_status": {
"summary": "History status updated successfully",
"value": "204 No response"
}
},
"response_204": {
"update_history_status": {
"summary": "History status updated successfully",
"value": {}
}
}
}
},
"markChatAsUnreadV3": {
"path": "/chats/{CHAT_ID1}",
"method": "put",
"examples": {
"request": {
"mark_as_read": {
"summary": "Mark chat as read",
"value": {
"operation": "mark_as_read",
"last_message_id": "1773813859592_51531973059"
}
},
"mark_as_unread": {
"summary": "Mark chat as unread",
"value": {
"operation": "mark_as_unread",
"message_id": "1773813859592_51531973059"
}
}
}
}
},
"clearChatMessagesV3": {
"path": "/chats/{CHAT_ID2}",
"method": "put",
"examples": {
"request": {
"clear_local_history": {
"summary": "Clear local chat history",
"value": {
"operation": "clear_local_history"
}
}
}
}
},
"closeChatV3": {
"path": "/chats/{CHAT_ID3}",
"method": "put",
"examples": {
"request": {
"close_chat": {
"summary": "Close a chat",
"value": {
"operation": "close_chat"
}
}
}
}
},
"addMembersToChatV3": {
"path": "/chats/{CHAT_ID}/members",
"method": "post",
"examples": {
"request": {
"add_members": {
"summary": "Add members to a group chat",
"value": {
"user_ids": [
"55743307",
"55622727"
]
}
}
},
"response_200": {
"add_members": {
"summary": "Members added successfully",
"value": {
"type": "chat.member",
"data": {
"chat_id": "2971901296197152390",
"added_user_ids": [
"55743307",
"55622727"
]
}
}
}
}
}
},
"removeMembersFromChatV3": {
"path": "/chats/{CHAT_ID}/members",
"method": "delete",
"examples": {
"response_200": {
"remove_members": {
"summary": "Members removed successfully",
"value": {
"type": "chat.member",
"data": {
"chat_id": "1729901956721293190",
"removed_user_ids": [
"55743307",
"55622727"
]
}
}
}
}
}
},
"forkChatV3": {
"path": "/chats/{CHAT_ID}/forks",
"method": "post",
"examples": {
"response_200": {
"fork_chat": {
"summary": "Forked chat created",
"value": {
"type": "chat",
"data": {
"chat_id": "3104729000000098765",
"name": "Fork: Q2 Product Review - Design, Engineering & QA",
"chat_type": "group_chat",
"participant_count": 3,
"created_time": "2025-04-29T10:00:00+05:30",
"last_modified_time": "2025-04-29T10:00:00+05:30",
"pinned": false,
"removed": false,
"creator": {
"id": "70027934",
"name": "Tim Harrison"
}
}
}
}
}
}
},
"sendTypingActivityV3": {
"path": "/chats/{CHAT_ID}/activities",
"method": "post",
"examples": {
"request": {
"Typing Indicator": {
"summary": "Send typing indicator",
"value": {
"action": "typing"
}
},
"Text entered": {
"summary": "Send text entered activity",
"value": {
"action": "text_entered"
}
},
"Text cleared": {
"summary": "Send text cleared activity",
"value": {
"action": "text_cleared"
}
}
}
}
}
}