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

Extensions Module

Zoho Cliq Extensions 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 Extensions. 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 6 operations across 3 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.

6 operations 3 paths 9 schemas 1 DELETE2 GET1 PATCH1 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 Extensions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.

Paths & Operations 6

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

Extensions 6

Extensions Module

POST
/extensions/{EXTENSION_ID}/installation
Install an extension
install_an_extension 2 params body → 204400401403404405406429
PUT
/extensions/{EXTENSION_ID}/installation
Upgrade an extension
update_extension 2 params body → 204400401403404405406429
PATCH
/extensions/{EXTENSION_ID}/properties
Add or update extension properties
add_or_update_extension_proper 1 param body → 200400401403404405406429
GET
/extensions/{EXTENSION_ID}/properties
Get extension properties
get_extension_properties 2 params → 200400401403404405406429
GET
/extensions/{EXTENSION_ID}/properties/{EXTENSION_PROPERTY_KEY_NAME}
Get a specific extension property
get_extension_property 2 params → 200400401403404405406429
DELETE
/extensions/{EXTENSION_ID}/properties/{EXTENSION_PROPERTY_KEY_NAME}
Delete a specific extension property
delete_extension_property 2 params → 204400401403404405406429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ExtensionPropertiesGetResponse (3 properties), extensioninstall_V3 (2 properties), appproperties (1 property), ExtensionPropertySingleResponse (1 property). Each schema is shown below with its type and property counts.

appproperties
object
Payload for setting extension properties.
1 property 1 required
extensioninstall_V3
object
Payload for installing an extension.
2 properties 1 required
smallalphawithspl_regex
string
Lowercase alphanumeric string with allowed special characters (hyphens and underscores) used as extension property keys.
ExtensionPropertiesGetResponse
object
Response returned when retrieving multiple extension properties. Keys are property names; values are their current string values.
3 properties
ExtensionPropertiesUpdateResponse
object
Response returned after adding or updating extension properties. Contains only the key-value pairs that were submitted in the request.
encryptedappkey_regex
string
Encrypted application key (appkey or EXTENSIONKEY) issued to a bot or extension, used as an alternative to OAuth for webhook-style authentication.
ExtensionPropertySingleResponse
object
Response returned when retrieving a single extension property.
1 property
longid_regex
string
Numeric long integer identifier used to reference platform components such as Commands, Functions, Widgets, Message Actions, Schedulers, and Extensions.
extensionupgrade_V3
object
Payload for upgrading an installed extension.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-cliq-extensions-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 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
Zoho Cliq mobilesettings API