Zoho Cliq pinmessages 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 pinmessages. 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
5 operations
across 2 paths,
and defines 9 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.
5 operations2 paths9 schemas1 DELETE2 GET1 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 pinmessages API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are pinned-message (8 properties), pin-information (5 properties), add-pinned-message-request (4 properties), get-pinned-messages-response (4 properties). Each schema is shown below with its type and property counts.
reorder-pinned-message-request
object
Request body for reordering a pinned message in the list.
3 properties2 required
pinned-message
object
A pinned message object. Contains the original message fields (id, type, content, sender, time, mentions) along with pin-specific fields.
8 properties
get-pinned-messages-response
object
Response envelope for listing all pinned messages.
4 properties
error-response
object
Error response returned by the Pin Messages API.
2 properties
add-pinned-message-request
object
Request body for pinning a message in a chat.
4 properties3 required
add-pinned-message-response
object
Response envelope after pinning a message.
3 properties
delete-pinned-messages-request
object
Request body for deleting specific pinned messages.
1 property1 required
pin-information
object
Metadata about the pin itself.
5 properties
get-primary-pinned-message-response
object
Response envelope when fetching the primary pinned message.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
