Zoho Cliq · Example Payload
Mypins
MessagingTeam CollaborationChatBotsWebhookSlash CommandsCommunications
Mypins is an example object payload from Zoho Cliq, with 10 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
getPinCategoriescreatePinCategoryremoveChatsAcrossCategoriesupdatePinCategorydeletePinCategoryreorderChatInCategoryreorderCategorybulkUpdateChatsInCategorypinChatunpinChat
Example Payload
{
"getPinCategories": {
"path": "/pin-categories",
"method": "get",
"examples": {
"response_400": {
"operation_failed": {
"summary": "Unexpected server error",
"value": {
"code": "operation_failed"
}
}
}
}
},
"createPinCategory": {
"path": "/pin-categories",
"method": "post",
"examples": {
"response_400": {
"param_missing": {
"summary": "A required parameter is missing from the request body",
"value": {
"code": "param_missing"
}
},
"operation_not_allowed": {
"summary": "User does not have permission for a chat in the given chat list",
"value": {
"code": "operation_not_allowed"
}
},
"max_folders_error": {
"summary": "Maximum number of folders reached",
"value": {
"code": "max_folders_error"
}
},
"operation_failed": {
"summary": "Unexpected server error",
"value": {
"code": "operation_failed"
}
}
}
}
},
"removeChatsAcrossCategories": {
"path": "/pin-categories",
"method": "delete",
"examples": {
"response_400": {
"operation_failed": {
"summary": "Unexpected server error",
"value": {
"code": "operation_failed"
}
}
}
}
},
"updatePinCategory": {
"path": "/pin-categories/{CATEGORY_ID}",
"method": "put",
"examples": {
"response_400": {
"client_not_synced": {
"summary": "last_sync_time is stale - re-fetch folders and retry",
"value": {
"code": "client_not_synced"
}
},
"invalid_inputs": {
"summary": "title, symbol, state, or chat_id was sent alongside chat_ids",
"value": {
"code": "invalid_inputs"
}
},
"operation_failed": {
"summary": "Unexpected server error or invalid inputs",
"value": {
"code": "operation_failed"
}
}
}
}
},
"deletePinCategory": {
"path": "/pin-categories/{CATEGORY_ID}",
"method": "delete",
"examples": {
"response_400": {
"operation_not_allowed": {
"summary": "Cannot delete the default folder",
"value": {
"code": "operation_not_allowed"
}
},
"operation_failed": {
"summary": "Unexpected server error",
"value": {
"code": "operation_failed"
}
}
}
}
},
"reorderChatInCategory": {
"path": "/pin-categories/{CATEGORY_ID1}",
"method": "put",
"examples": {
"response_400": {
"client_not_synced": {
"summary": "last_sync_time is stale - re-fetch folders and retry",
"value": {
"code": "client_not_synced"
}
},
"invalid_inputs": {
"summary": "title, symbol, state, or chat_id was sent alongside chat_ids",
"value": {
"code": "invalid_inputs"
}
},
"operation_failed": {
"summary": "Unexpected server error or invalid inputs",
"value": {
"code": "operation_failed"
}
}
}
}
},
"reorderCategory": {
"path": "/pin-categories/{CATEGORY_ID2}",
"method": "put",
"examples": {
"response_400": {
"client_not_synced": {
"summary": "last_sync_time is stale - re-fetch folders and retry",
"value": {
"code": "client_not_synced"
}
},
"invalid_inputs": {
"summary": "title, symbol, state, or chat_id was sent alongside chat_ids",
"value": {
"code": "invalid_inputs"
}
},
"operation_failed": {
"summary": "Unexpected server error or invalid inputs",
"value": {
"code": "operation_failed"
}
}
}
}
},
"bulkUpdateChatsInCategory": {
"path": "/pin-categories/{CATEGORY_ID3}",
"method": "put",
"examples": {
"response_400": {
"client_not_synced": {
"summary": "last_sync_time is stale - re-fetch folders and retry",
"value": {
"code": "client_not_synced"
}
},
"invalid_inputs": {
"summary": "title, symbol, state, or chat_id was sent alongside chat_ids",
"value": {
"code": "invalid_inputs"
}
},
"operation_failed": {
"summary": "Unexpected server error or invalid inputs",
"value": {
"code": "operation_failed"
}
}
}
}
},
"pinChat": {
"path": "/chats/{CHAT_ID}/pins",
"method": "post",
"examples": {
"response_400": {
"max_pins_error": {
"summary": "The user has reached the maximum number of pinned chats in the folder",
"value": {
"code": "max_pins_error"
}
},
"chat_access_denied": {
"summary": "Caller is not a participant of this chat",
"value": {
"code": "chat_access_denied"
}
},
"operation_not_allowed": {
"summary": "Caller does not have permission to pin this chat",
"value": {
"code": "operation_not_allowed"
}
},
"chat_operation_failed": {
"summary": "Unexpected server error",
"value": {
"code": "chat_operation_failed"
}
}
}
}
},
"unpinChat": {
"path": "/chats/{CHAT_ID}/pins",
"method": "delete",
"examples": {
"response_400": {
"chat_access_denied": {
"summary": "Caller is not a participant of this chat",
"value": {
"code": "chat_access_denied"
}
},
"chat_operation_failed": {
"summary": "Unexpected server error",
"value": {
"code": "chat_operation_failed"
}
}
}
}
}
}Work with this as data
Every example here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for examples
4 MCP tools reach this
find_examplesBrowse and filter every example in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This example
curl "https://apis.io/api/v1/examples/mypins"
All examples
curl "https://apis.io/api/v1/examples?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.