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

Functions Module

Zoho Cliq Functions 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 Functions. 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 9 operations across 4 paths, and defines 11 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.

9 operations 4 paths 11 schemas 2 DELETE3 GET2 PATCH2 POST

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 Functions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.

Paths & Operations 9

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

Functions 9

Functions Module

POST
/functions
Create a new function
create_a_new_function body → 200400401403404405406429
GET
/functions
List all functions
list_all_functions 3 params → 200400401403404405406429
PATCH
/functions/{FUNCTION_ID}
Update an existing function
update_an_existing_function 1 param body → 200400401403404405406429
GET
/functions/{FUNCTION_ID}
Get details of a specific function
get_details_of_a_specific_func 1 param → 200400401403404405406429
DELETE
/functions/{FUNCTION_ID}
Delete a specific function
delete_a_specific_function 1 param → 204400401403404405406429
POST
/functions/{FUNCTION_ID}/handlers
Create a handler for a specific function
createFunctionHandler 1 param body → 200400401403404405406429
PATCH
/functions/{FUNCTION_ID}/handlers/{FUNCTION_HANDLER_TYPE}
Update a handler for a specific function
updateFunctionHandler 2 params body → 200400401403404405406429
GET
/functions/{FUNCTION_ID}/handlers/{FUNCTION_HANDLER_TYPE}
Get details of a specific function handler
getFunctionHandler 2 params → 200400401403404405406429
DELETE
/functions/{FUNCTION_ID}/handlers/{FUNCTION_HANDLER_TYPE}
Delete a handler from a specific function
deleteFunctionHandler 2 params → 200400401403404405406429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are FunctionListResponse (7 properties), v3-function-create (5 properties), v3-exehandler-create (3 properties), FunctionHandlerDetailsResponse (3 properties). Each schema is shown below with its type and property counts.

v3-exehandler-create
object
Payload for creating a new function handler.
3 properties 1 required
FunctionListResponse
object
Response schema for listing functions.
7 properties
FunctionResponse
object
Response schema for function create, get, and update operations.
3 properties
v3-function-edit
object
Payload for updating a function. functiontype cannot be changed after creation.
3 properties
v3-exehandler-edit
object
Payload for updating an existing function handler.
2 properties
FUNCTION_HANDLER_TYPE_regex
string
Name of a function handler.
v3-function-create
object
Payload for creating a new function.
5 properties 3 required
NoResponse
object
Represents an empty successful response where no payload is returned.
1 property
longid_regex
string
Numeric long integer identifier used to reference platform components such as Commands, Functions, Widgets, Message Actions, Schedulers, and Extensions.
FunctionHandlerDetailsResponse
object
Response schema returned when fetching the full details of a specific function handler.
3 properties
FunctionHandlerResponse
object
Response schema for function handler operations.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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