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 mypins API

My Pins and Chat Folders Module

Zoho Cliq mypins 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 mypins. 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 10 operations across 6 paths, and defines 13 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.

10 operations 6 paths 13 schemas 3 DELETE1 GET2 POST4 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 mypins API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.

Paths & Operations 10

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

mypins 10

My Pins and Chat Folders Module

GET
/pin-categories
Retrieve chat folders
getPinCategories 1 param → 200400401403404405406429
POST
/pin-categories
Create a chat folder
createPinCategory body → 200400401403404405406429
DELETE
/pin-categories
Remove pinned chats across chat folders
removeChatsAcrossCategories 1 param → 204400401403404405406429
PUT
/pin-categories/{CATEGORY_ID}
Modify a chat folder
updatePinCategory 1 param body → 204400401403404405406429
DELETE
/pin-categories/{CATEGORY_ID}
Delete a chat folder
deletePinCategory 2 params → 204400401403404405406429
PUT
/pin-categories/{CATEGORY_ID1}
Reorder a chat within a chat folder
reorderChatInCategory 1 param body → 204400401403404405406429
PUT
/pin-categories/{CATEGORY_ID2}
Reorder a chat folder
reorderCategory 1 param body → 204400401403404405406429
PUT
/pin-categories/{CATEGORY_ID3}
Replace chats in a chat folder
bulkUpdateChatsInCategory 1 param body → 204400401403404405406429
POST
/chats/{CHAT_ID}/pins
Pin a chat to a chat folder
pinChat 1 param body → 200400401403404405406429
DELETE
/chats/{CHAT_ID}/pins
Unpin a chat
unpinChat 1 param → 200400401403404405406429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are pinned-chat (7 properties), pin-category (5 properties), update-pin-category-details-request (3 properties), reorder-chat-in-category-request (3 properties). Each schema is shown below with its type and property counts.

create-pin-category-response
object
Response envelope after creating a pin folder.
3 properties
create-pin-category-request
object
Request body for creating a new pin folder.
3 properties 1 required
reorder-category-request
object
Request body for updating a pin folder. Send exactly one operation type per request. Operation types : Reorder a Folder : Send pinabove only (no chatid ) with…
2 properties 1 required
bulk-update-chats-in-category-request
object
Request body for updating a pin folder. Send exactly one operation type per request. Operation types : Bulk Update Chats : Send chatids (array) with required l…
2 properties 2 required
pin-category
object
Represents a pin folder (chat folder) object. Fields marked conditional are only present when the matching includefields value is requested. Note: The default…
5 properties
get-pin-categories-response
object
Response envelope for listing all pin folders.
3 properties
reorder-chat-in-category-request
object
Request body for updating a pin folder. Send exactly one operation type per request. Operation types : Reorder a Chat : Send chatid with optional pinabove and…
3 properties 2 required
error-response
object
Error response returned by the My Pins API.
2 properties
update-pin-category-details-request
object
Request body for updating a pin folder. Send exactly one operation type per request. Operation types : Update Folder Details : Send title , symbol , and/or sta…
3 properties
pin-chat-response
object
Response envelope after pinning a chat.
2 properties
pin-chat-request
object
Request body for pinning a chat. All fields are optional.
1 property
unpin-chat-response
object
Response envelope after unpinning a chat.
2 properties
pinned-chat
object
Represents a pinned chat entry within a folder.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-cliq-mypins-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