### Create Channel Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of a successful response when creating a channel. It includes details about the channel, permissions, and participant information. ```json { "name": "#Zylker-Support", "chat_id":"CT_1184653329648523663_62439860", "description": "To post all the support tickets from customers", "image_url": "http://cliq.zoho.com/channel/T4000000040005_4435792_1498572169593/photo.do", "level": "team", "invite_only" : false, "status": "created", "channel_id": "T4000000040005", "organization_id": "4435792", "creator_id": "4435866", "creator_name": "PatriciaJames", "creation_time": "2017-07-03T14:59:20+05:30", "last_modified_time": "2017-07-03T15:59:20+05:30", "current_user_role": "super_admin", "participant_count": 1, "admin_permission": { "add_participant": true, "archive_channel": true, "audio_conference": true, "clear_all_messages": true, "delete_channel": true, "delete_my_msg": true, "delete_others_message": true, "edit_channel_info": true, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": true, "remove_participant": true, "send_message": true, "special_mentions": true, "sticky_message": true, "unarchive_channel": true, "video_conference": true }, "moderator_permission": { "add_participant": true, "archive_channel": false, "audio_conference": true, "clear_all_messages": false, "delete_channel": false, "delete_my_msg": true, "delete_others_message": false, "edit_channel_info": true, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": true, "remove_participant": true, "send_message": true, "special_mentions": false, "sticky_message": true, "unarchive_channel": false, "video_conference": true }, "member_permission": { "add_participant": true, "archive_channel": false, "audio_conference": true, "clear_all_messages": false, "delete_channel": false, "delete_my_msg": true, "delete_others_message": false, "edit_channel_info": false, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": false, "remove_participant": false, "send_message": true, "special_mentions": false, "sticky_message": false, "unarchive_channel": false, "video_conference": true }, "unique_name": "zylkersupport", "teams": { "4435961": "SALES", "4453461": "MARKETING" }, "joined": true, "pinned": false, "total_message_count": "100", "unread_message_count": 5, "unread_time":"2017-07-03T15:59:20+05:30" } ``` -------------------------------- ### Response Example for Get Thread Followers Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example JSON response when retrieving followers of a thread, listing user IDs, email IDs, and names. ```json { "data": [ { "user_id": "15066855", "email_id": "scott.fisher@zylker.com", "name": "Scott" }, { "user_id": "15071629", "email_id": "mark.twine@zylker.com", "name": "Mark" } ] } ``` -------------------------------- ### Participants Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of the JSON response when retrieving participants. It includes details such as email, name, start and end times, role, and ID for each participant. ```json { "url":"/api/v2/mediasessions/15093303_1654794155339_GN_1256255415498864798_15093376/participants" "type":"participant", "data":[ { "email_id":"scott.fisher@zylker.com", "name":"Scott", "end_time":1654797815323, "start_time":1654794247047, "role":"host", "id":"12543958" }, { "email_id":"olivia.palmer@zylker.com", "name":"Admin Account", "end_time":1654794872529, "start_time":1654794859243, "role":"speaker", "id":"14395792" } ] } ``` -------------------------------- ### Response Example for Channel Update Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of the response received after successfully updating a channel. It includes details about the channel's properties and permissions. ```json { "name": "#Zylker-Customer-Support", "description": "To post all the support tickets from customers", "image_url": "http://cliq.zoho.com/channel/T4000000040005_4435792_1498572169593/photo.do", "level": "team", "invite_only" : false, "status": "created", "channel_id": "T4000000040005", "organization_id": "4435792", "creator_id": "4435866", "creator_name": "PatriciaJames", "creation_time": "2017-07-03T14:59:20+05:30", "last_modified_time": "2017-07-03T15:59:20+05:30", "current_user_role": "super_admin", "last_message_info": { "sender_id": "53787102", "message_type": "text", "message_time": "2017-07-03T15:59:20+05:30", "message": "Hey!", "sender_display_name": "PatriciaJames" }, "participant_count": 1, "admin_permission": { "add_participant": true, "archive_channel": true, "audio_conference": true, "clear_all_messages": true, "delete_channel": true, "delete_my_msg": true, "delete_others_message": true, "edit_channel_info": true, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": true, "remove_participant": true, "send_message": true, "special_mentions": true, "sticky_message": true, "unarchive_channel": true, "video_conference": true }, "moderator_permission": { "add_participant": true, "archive_channel": false, "audio_conference": true, "clear_all_messages": false, "delete_channel": false, "delete_my_msg": true, "delete_others_message": false, "edit_channel_info": true, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": true, "remove_participant": true, "send_message": true, "special_mentions": false, "sticky_message": true, "unarchive_channel": false, "video_conference": true }, "member_permission": { "add_participant": true, "archive_channel": false, "audio_conference": true, "clear_all_messages": false, "delete_channel": false, "delete_my_msg": true, "delete_others_message": false, "edit_channel_info": false, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": false, "remove_participant": false, "send_message": true, "special_mentions": false, "sticky_message": false, "unarchive_channel": false, "video_conference": true }, "unique_name": "zylkersupport", "teams": { "4435961": "SALES", "4453461": "MARKETING" }, "joined": true, "pinned": false, "total_message_count": "100", "unread_message_count": 5, "unread_time": "2017-07-03T15:59:20+05:30" } ``` -------------------------------- ### Response Example for Adding Userfield Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example response after successfully adding a userfield, showing the created userfield's details including its ID and options. ```json { "url": "/api/v2/userfields", "data": { "system_defined": false, "is_searchable": false, "unique_name": "vaccinated", "name": "Vaccinated", "id": "1901318000003603019", "creation_time": "2021-11-30T21:47:14-08:00", "last_modified_time": "2021-11-30T21:47:14-08:00", "mandatory": true, "encrypted": false, "edit_permission": true, "organization_id": "631836344", "enabled": true, "type": "drop_down", "label": "Vaccinated", "options": [ { "name": "No", "id": "1901318000003603023" }, { "name": "Yes", "id": "1901318000003603021" } ] } } ``` -------------------------------- ### Response Example for Posting a Channel Message Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example response after successfully posting a message in a channel. The `message_id` from this response is crucial for creating a thread. ```json {"message_id":"1599044334698_117280617320"} ``` -------------------------------- ### Response Example for Get Messages Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of the JSON response when retrieving messages from a chat. It includes sender information, message ID, timestamp, type, and content. ```json { "data": [ { "sender": { "name": "Scott", "id": "12345678" }, "id": "1542711601585_349430767610289", "time": 1542711601585, "type": "text", "content": { "text": "Hi! What time is the review meeting today?" } }, { "sender": { "name": "Olivia", "id": "22345678" }, "id": "1542711601631_349435062577631", "time": 1542711601631, "type": "text", "content": { "text": "Hey Scott! It's at 4:00 PM." } }, { "sender": { "name": "Scott", "id": "12345678" }, "id": "1542798001273_349439443944569", "time": 1542798001273, "type": "text", "content": { "text": "Thanks! My presentation will focus on- Feature updates for Q1" } }, { "sender": { "name": "Scott", "id": "12345678" }, "id": "1543384891842_351840917549285", "time": 1543384891842, "type": "file", "content": { "thumbnail": { "height": "230", "width": "400", "blur_data": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY22jK/dwMdD65q/QKACiiigApAQSR6HBpTTcBNxUcscn+X9KAHUU1TvyGAI9KUKqk7Rj6UALigADpSA01VVCxRVUsdzYGMnpk/kKAH0UmaKAP//Z" }, "file": { "name": "Feature-overview.jpg", "type": "image/jpeg", "dimensions": { "height": 3510, "size": 559008, "width": 2552 }, "id": "f3791c2279a67f6e5cbc8e1beb41ded85da2bdc672e2496ba9af50c0c24c8e2e453862a8a28becb86f859ab142d44633b05a8fb2ff34955c9e9824527c15cd03" }, "comment": "" } } ] } ``` -------------------------------- ### Get Department Details API Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example response when retrieving department details. It includes information such as the number of members, lead details, department name, parent department ID, and whether it's the default department. ```json { "data": { "members_count": "7", "lead": { "id": "631830849", "organization_id": "631836344", "zoid": "54107592", "display_name": "Scott Fisher", "email_id": "scott.fisher@zylker.com", "zuid": "631830849", "name": "Scott Fisher" }, "name": "Marketing", "parent_department_id": "1901318000001424001", "lead_zuid": "631830849", "is_default": false, "id": "1901318000001071015" } } ``` -------------------------------- ### Retrieve Records with Start Token - GET API Source: https://www.zoho.com/cliq/help/restapi/v2/index.html Use the 'start_token' parameter to retrieve the next set of records. This token is obtained from the 'next_token' in the response of a range-based query and is valid for only one immediate request. ```http GET https://cliq.zoho.com/api/v2/storages/{name}/records?start_token=2666a59c-b894-40f5-82c5-3703fbde2ec9 ``` -------------------------------- ### Update User Details API Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html Example of a successful response when updating user details. ```json { "data": { "employee_id": "0976", "first_name": "Scott", "reportingto": { "name": "Russell Thomas", "id": "54218867", "country": "ca", "email_id": "russellt@zylker.com", "zoid": "54107592", "organization_id": "null", "timezone": "Asia/Calcutta", "first_name": "Russell", "full_name": "Russell Thomas", "display_name": "Russell Thomas", "last_name": "Thomas" }, "mobile": "65465418698", "zoid": "54107592", "organization_id": "631836344", "email_id": "olivia.palmer@zylker.com", "extension": "551", "work_location": "578", "id": "631830846", "timeoffset": -43200000, "timezone": "Etc/GMT+12", "language": "English", "status": "active", "country": "United States", "department": { "name": "Creative Writers", "id": "1901318000001615007" }, "last_name": "Palmer", "full_name": "Scott Palmer", "designation": { "name": "Content Writer", "id": "1901318000001072013" }, "display_name": "Scott", "name": "Scott Palmer" }, "custom_attributes": { "dateofjoining": "-" } } ``` -------------------------------- ### Response Example for Creating a Thread Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example response after successfully creating a thread and sending a message within it. It provides the `message_id` for the newly created thread message. ```json {"message_id":"1275417686584_20804595296"} ``` -------------------------------- ### Zoho Cliq API v2 Event Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of the JSON response structure when retrieving events. It includes details for each event such as location, creator, start and end times, attendees, and meeting links. ```json { "data": [ { "location": "Conference Room 21", "entity_id": "47f22789-124f-4ee3-88ef-6b58987b4c04", "is_big_chat_event": false, "type": "video_conference", "isallday": false, "creator": { "name": "Scott Fisher", "email": "scott.fisher@zylker.com", "id": "940154121" }, "entity_type": 8, "end_time": 1738942200000, "attendees": [ { "status": "accepted", "name": "scott.fisher@zylker.com", "email": "scott.fisher@zylker.com", "id": "940154121" } ], "edit_tag": "1738835150914", "start_time": 1738938600000, "id": "427812df9891223aca537f0e8e7ad2a7c@zoho.com", "meeting_link": "https://cliq.zoho.com/meeting/1BKJ7692134Y6", "timezone": "Asia/Kolkata", "description": "", "calendar_id": "NDg4MTc3NTAwMDAwMDAwOTAwM3wzZG==", "organizer": { "name": "Scott Fisher", "email": "scott.fisher@zylker.com", "id": "940154121" }, "title": "Zylker Marketing Forum", "role": "organizer" }, { "recurrence_id": "20250210T050000Z", "chat_id": "CT_2036712241099506557_87610291-T-97473479223481134", "entity_id": "62b8cab2-7b01-4054-8b59-62f1d11a9057", "is_big_chat_event": false, "type": "video_conference", "isallday": false, "entity_type": 10, "creator": { "name": "Ryan West", "email": "ryan.west@zylker.com", "id": "786091523" }, "end_time": 1739165400000, "attendees": [ { "status": "accepted", "name": "scott.fisher@zylker.com", "email": "scott.fisher@zylker.com", "id": "940154121" } ], "edit_tag": "1676262430034", "start_time": 1739163600000, "id": "93a740b282f44a7c9c1360d7d1d7745a@zoho.com", "timezone": "Asia/Kolkata", "calendar_id": "NDg4MTc3NTAwMDAwMDAwOTAwM3wzZGV==", "organizer": { "name": "Ryan West", "email": "ryan.west@zylker.com", "id": "786091523" }, "title": "Weekly Standup - Product Development Sprint", "role": "attendee" }, ] } ``` -------------------------------- ### Response Example for Get Non-Followers Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example JSON response when retrieving non-followers of a thread, listing user IDs, email IDs, and names. ```json { "data": [ { "user_id": "15012855", "email_id": "emily.woods@zylker.com", "name": "Emily" }, { "user_id": "15071629", "email_id": "james.baken@zylker.com", "name": "James" } ] } ``` -------------------------------- ### Event Edit Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of a successful response after editing an event. It includes updated event details and metadata. ```json { data: [ { "location": "Lake Plaza", "entity_id": "47f78d99-049f-4e313-08ef-6b588976b4c4", "is_big_chat_event": false, "type": "video_conference", "isallday": false, "creator": { "name": "Scott Fisher", "email": "scott.fisher@zylker.com", "id": "9087651" }, "entity_type": 8, "end_time": 1738832190000, "attendees": [ { "status": "accepted", "name": "Ryan West", "email": "ryan.west@zylker.com", "id": "89472161" } ], "edit_tag": "1738835150914", "start_time": 1738828590000, "id": "427812df9891223aca537f0e8e7ad2a7c@zoho.com", "meeting_link": "https://cliq.zoho.com/meeting/1BK4IK987W6W", "timezone": "Asia/Kolkata", "description": "Join the Marketing Forum to discuss trends.", "calendar_id": "NDg4MTc3NTAwMDAwMDAwJhNWRiZTU2MzMyY2NjMQ==", "organizer": { "name": "Scott Fisher", "email": "scott.fisher@zylker.com", "id": "9087651" }, "title": "Zylker Marketing Forum", "role": "organizer" } ] } ``` -------------------------------- ### Response Example for Update Channel Permissions Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of a successful response when updating channel permissions. It includes details about the channel, creator, and the updated permissions for admin, moderator, and member roles. ```json { "name": "#Zylker-Support", "description": "To post all the support tickets from customers", "image_url": "http://cliq.zoho.com/channel/T4000000040005_4435792_1498572169593/photo.do", "level": "team", "invite_only" : false, "status": "created", "channel_id": "T4000000040005", "organization_id": "4435792", "creator_id": "4435866", "creator_name": "PatriciaJames", "creation_time": "2017-07-03T14:59:20+05:30", "last_modified_time": "2017-07-03T15:59:20+05:30", "current_user_role": "super_admin", "last_message_info": { "sender_id": "53787102", "message_type": "text", "message_time": "2017-07-03T15:59:20+05:30", "message": "Hey!", "sender_display_name": "PatriciaJames" }, "participant_count": 1, "admin_permission": { "add_participant": true, "archive_channel": true, "audio_conference": true, "clear_all_messages": true, "delete_channel": true, "delete_my_msg": true, "delete_others_message": true, "edit_channel_info": true, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": true, "remove_participant": true, "send_message": true, "special_mentions": true, "sticky_message": true, "unarchive_channel": true, "video_conference": true }, "moderator_permission": { "add_participant": true, "archive_channel": false, "audio_conference": true, "clear_all_messages": false, "delete_channel": false, "delete_my_msg": true, "delete_others_message": false, "edit_channel_info": true, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": true, "remove_participant": true, "send_message": true, "special_mentions": false, "sticky_message": true, "unarchive_channel": false, "video_conference": true }, "member_permission": { "add_participant": true, "archive_channel": false, "audio_conference": true, "clear_all_messages": false, "delete_channel": false, "delete_my_msg": true, "delete_others_message": false, "edit_channel_info": false, "edit_my_msg": true, "leave_channel": true, "mention_users": true, "post_reply": true, "prime_time": false, "remove_participant": false, "send_message": true, "special_mentions": false, "sticky_message": false, "unarchive_channel": false, "video_conference": true }, "unique_name": "zylkersupport", "teams": { "4435961": "SALES", "4453461": "MARKETING" }, "joined": true, "pinned": false, "total_message_count": "100", "unread_message_count": 5, "unread_time": "2017-07-03T15:59:20+05:30" } ``` -------------------------------- ### Create Department API Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of a successful response when creating a department. It includes the details of the newly created department, such as its ID, name, lead information, and parent department ID. ```json { "data": { "lead": { "id": "631830849", "organization_id": "631836344", "zoid": "54107592", "display_name": "Scott Fisher", "email_id": "scott.fisher@zylker.com", "zuid": "631830849", "name": "Scott Fisher" }, "name": "Zylker APAC Sales", "parent_department_id": "1901318000001424001", "lead_zuid": "631830849", "is_default": false, "id": "1901318000002280001" } } ``` -------------------------------- ### Event Details Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of the JSON response structure when successfully retrieving event details. It includes information about attendees, times, and meeting links. ```json { "data": { "location": "Conference Room 21", "entity_id": "153d07dc-0119-4c5d-b5f4-f01e646f3062", "is_big_chat_event": false, "type": "video_conference", "isallday": false, "creator": { "name": "Scott Fisher", "email": "scott.fisher@zylker.com", "id": "911546221" }, "entity_type": 8, "end_time": 1738832160000, "attendees": [ { "status": "yet_to_respond", "name": "Rufus Williams", "email": "r.william@zylker.com", "id": "856710923" }, { "status": "accepted", "name": "Scott Fisher", "email": "scott.fisher@zylker.com", "id": "911546221" } ], "edit_tag": "1738836769834", "start_time": 1738828560000, "id": "dab7bc69da63456771e6eb39b24499bb@zoho.com", "meeting_link": "https://cliq.zoho.com/meeting/1JK3BAGOWN7E9", "timezone": "Asia/Kolkata", "description": "Join the Zylker Marketing Forum to discuss trends, strategies, and insights with industry experts.", "calendar_id": "NDg4MTc3NTAwMDAwMDAwOTAwM3wzZGViYz==", "meeting_details": { "session_end_time": -1, "session_start_time": -1, "id": "1775998002315268245", "end_time": -1, "start_time": 1738828560000, "is_active": false, "is_partial": true, "scheduled_start_time": 1738828560000, "type": "video", "scheduled_end_time": 1738832160000, "title": "Zylker Marketing Forum", "session_key": "153d07dc-0119-4c5d-b5f4-f01e646f3062", "host": { "name": "Scott Fisher", "id": "911546221" }, "scope": "personal", "participant_count": 1, "has_presentations": false }, "organizer": { "name": "Scott Fisher", "email": "scott.fisher@zylker.com", "id": "911546221" }, "title": "Zylker Marketing Forum", "role": "organizer" } } ``` -------------------------------- ### Response Example for Retrieve Message Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of the JSON response when retrieving a specific message. It includes sender details, message ID, time, type, and content. ```json { "sender": { "name": "Scott Fisher", "id": "12345678" }, "id": "1543320941513_23291239955324", "time": 1543320941513, "type": "text", "content": { "text": "Hello Guys!" } } ``` -------------------------------- ### Media Session History Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html Example JSON response structure for the media session history API, detailing call and meeting information. ```json { "data":[ { "id":"392330000000598005", "end_time":1643361458859, "session_id":"b13d0691-ca45-47c7-b6ad-6cbdf339b9e9", "start_time":1643361407614, "notes": false, "is_partial":true, "nrs_id":"62440502_1643361407784_1643361407650", "type":"audio_conference", "title":"av_recording", "scope":"personal", "host": { "name":"\"Scott Fisher", "id":"62589940502" }, "participant_count":10 }, { "recording":true, "id":"392330000089297001", "end_time":1643283428901, "session_id":"d419f9e8-36c7-4179-b35a-d7a38df78860", "start_time":1643283406317, "notes":false, "is_partial":true, "nrs_id":"62440502_1643283406451_CT_1184653329648523663_62439860", "type":"video_conference", "chat_id":"CT_11846783329648523663_62439860", "title":"Marketing Campaigns", "scope":"chat", "host":{ "name":"\"Scott Fisher", "id":"62589940502" }, "chat":{ "title":"Q3 releases", "id":"CT_1184653329648523663_62439860" }, "participant_count":15 }, ] } ``` -------------------------------- ### Calendar API Response Example Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is an example of the JSON response structure when successfully retrieving calendar data. It includes details for each calendar, such as its ID, name, and settings. ```json { "data": [ { "reminders": [ { "minutes": "-15", "action": "email" } ], "color": "#8cbf40", "timezone": "Asia/Calcutta", "textcolor": "#FFFFFF", "description": "", "privilege": "owner", "type": 0, "calemptiedtime": "20230316T052733Z", "uid": "1683be4ab6c74d2ab02e6450a0b34d4a", "canSendMail": true, "modifiedtime": 1663320706496, "alarm": [ { "action": "email", "trigger": "-900000" } ], "isdefault": true, "calendar_modifiedtime": 1663320706496, "id": "310935000000002003", "order": 0, "lastmodifiedtime": "20230316T092945Z", "owner": "70421274", "visibility": true, "include_infreebusy": true, "createdtime": 1663320706496, "calendar_createdtime": 1663320706496, "name": "user", "ctag": 1678958985948, "category": "own", "status": true, "caltype": "own" }, { "color": "#8cbf40", "timezone": "Asia/Calcutta", "textcolor": "#FFFFFF", "description": "", "privilege": "owner", "type": 0, "uid": "46d3aef248384773b1649360152a44eb", "canSendMail": true, "modifiedtime": 1678946331370, "isdefault": false, "calendar_modifiedtime": 1678946331370, "id": "310935000000136011", "order": 5, "lastmodifiedtime": "20230214T055915Z", "owner": "70421274", "visibility": false, "include_infreebusy": false, "createdtime": 1678946331370, "calendar_createdtime": 1678946331370, "name": "Hidden calendar", "ctag": 1676354355042, "category": "own", "status": true, "caltype": "own" } ] } ``` -------------------------------- ### Example for using the access token Source: https://www.zoho.com/cliq/help/restapi/v2/index.html Demonstrates how to use the obtained access token in API requests. ```APIDOC ## GET https://cliq.zoho.com/api/v2/channels ### Description Example request to fetch channels using an access token. ### Method GET ### Endpoint https://cliq.zoho.com/api/v2/channels ### Request Header - **Authorization** (string) - Required - Zoho-oauthtoken [access_token] ``` -------------------------------- ### Instant Button Syntax using System API Source: https://www.zoho.com/cliq/help/restapi/v2/index.html Use this syntax to create an instant button that triggers a system API action. Ensure you have the ZohoCliq.Webhooks.CREATE OAuth scope. The button label is displayed to the user, and the system.api part specifies the action and the user ID. ```plaintext [Button Label](system.api|system action/user ID) ``` -------------------------------- ### Instant Button triggered using System API Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This section describes how to trigger an instant button using the System API. It requires the `ZohoCliq.Webhooks.CREATE` OAuth scope. The example shows a POST request to send a message with an instant button that initiates a video call. ```APIDOC ## Instant Button triggered using System API ### Required OAuth Scope : This API can be accessed with the OAuth scope : `ZohoCliq.Webhooks.CREATE` ``` [Button Label](system.api|system action/user ID) Example: Request POST https://cliq.zoho.com/api/v2/chats/{chat_id}/message Payload { "text":"Hey!Let's have a quick call! [Join](system.api|videocall/123456789)" } ``` ### Params * **Button Label** (string, Required): Display value of the button. Maximum number of characters allowed : 20 * **Button Action** (string, Required): Type of action the button should perform. In this case : `system.api` * **System action/ID** (string, Required): System action allowed values: `audiocall` | `videocall` | `startchat` | `invite` | `locationpermission`. ID is the `zuid` of the user to whom the system action should be performed. Specify the type of system action. ID is the user ID where you would like to perform the action. ``` -------------------------------- ### Retrieve Records by Range - GET API Source: https://www.zoho.com/cliq/help/restapi/v2/index.html Fetch a set of records from a specific database by specifying 'from_index' and 'limit'. 'from_index' is the starting point, and 'limit' is the number of records to fetch. The response includes a 'next_token' for subsequent requests. ```http GET https://cliq.zoho.com/api/v2/storages/{name}/records?from_index=1&limit=2 ``` -------------------------------- ### Sample Grant Token Response Source: https://www.zoho.com/cliq/help/restapi/v2/index.html This is a sample callback URL containing the authorization code after user consent. ```http http://accounts.zoho.com/oauth2callback?state=5466400890088961855&code=1000.dd7e47321d48b8a7e312e3d6eb1a9bb8.b6c07ac766ec11da98bf6a261e24dca4 ``` -------------------------------- ### Get Files Source: https://www.zoho.com/cliq/help/restapi/v2/index.html Get files from any chat, channel or bot which you are a part of using its file id. You can retrieve the file id using the Get messages endpoint. ```APIDOC ## GET https://cliq.zoho.com/api/v2/files/{file_id} ### Description Retrieves a file using its unique identifier from any chat, channel, or bot accessible to the user. ### Method GET ### Endpoint https://cliq.zoho.com/api/v2/files/{file_id} ### Parameters #### Path Parameters - **file_id** (String) - Required - The unique identifier of the file. ### Quota Limit The quota limit for this API is **50 requests per minute per user** ### Required OAuth Scope This API can be accessed with the OAuth scope : `ZohoCliq.Attachments.READ` ``` -------------------------------- ### Get Department Members Source: https://www.zoho.com/cliq/help/restapi/v2/index.html You can use this API to get the list of all the department members. ```APIDOC ## Get Department Members ### Description Retrieves a list of all members within a specified department. ### Method GET ### Endpoint https://cliq.zoho.com/api/v2/departments/{department_id}/members ### Parameters #### Path Parameters - **department_id** (string) - Required - The ID of the department to retrieve members from. ### Response #### Success Response (200) - **data** (array) - Contains a list of department member objects. - **email_id** (string) - The email address of the member. - **zuid** (string) - The Zoho Unique ID of the member. - **zoid** (string) - The Zoho Organization ID. - **display_name** (string) - The display name of the member. - **name** (string) - The full name of the member. - **organization_id** (string) - The organization ID. - **id** (string) - The ID of the member. ### Response Example ```json { "data": [ { "email_id": "amelia.b@zylker.com", "zuid": "636000786", "zoid": "54107592", "display_name": "Amelia", "name": "Amelia Burrows", "organization_id": "631836344", "id": "631830849" } ] } ``` ```