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

Slash Commands Module

Zoho Cliq slashcommands 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 slashcommands. 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 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.

9 operations 4 paths 9 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 slashcommands 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.

slashcommands 9

Slash Commands Module

POST
/commands
Create a slash command
creating_extension_command body → 200400401403404405406429
GET
/commands
List all commands
get_list_of_commands 3 params → 200400401403404405406429
PATCH
/commands/{SLASH_COMMAND_ID}
Update a slash command
editing_extension_command 1 param body → 200400401403404405406429
GET
/commands/{SLASH_COMMAND_ID}
Get a command
get_a_command 1 param → 200400401403404405406429
DELETE
/commands/{SLASH_COMMAND_ID}
Delete a slash command
deleting_extension_command 1 param → 204400401403404405406429
POST
/commands/{SLASH_COMMAND_ID}/handlers
Create a handler for a specific command
createCommandHandler 1 param body → 200400401403404405406429
PATCH
/commands/{SLASH_COMMAND_ID}/handlers/{COMMAND_HANDLER_TYPE}
Update a handler for a specific command
updateCommandHandler 2 params body → 200400401403404405406429
GET
/commands/{SLASH_COMMAND_ID}/handlers/{COMMAND_HANDLER_TYPE}
Get details of a specific command handler
get_details_of_a_specific_comm 2 params → 200400401403404405406429
DELETE
/commands/{SLASH_COMMAND_ID}/handlers/{COMMAND_HANDLER_TYPE}
Delete a handler from a specific command
deleteCommandHandler 2 params → 204400401403404405406429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are create-slash-command-request-body (10 properties), update-slash-command-request-body (9 properties), list-all-slash-commands-response (5 properties), SlashCommandResponse (3 properties). Each schema is shown below with its type and property counts.

update-slash-command-request-body
object
Payload for updating a slash command. All fields are optional; only the fields provided will be updated.
9 properties
create-slash-command-request-body
object
Payload for creating a new slash command.
10 properties 3 required
v3-exehandler-create
object
Payload for creating a new handler. For Deluge commands, provide type and script. For Webhook commands, provide type and permissions.
3 properties 1 required
COMMAND_HANDLER_TYPE_regex
string
Name of a slash command handler. Accepted values: executionhandler (fires on command invocation), suggestionhandler (fires to generate autocomplete suggestions…
v3-exehandler-edit
object
Payload for updating an existing handler. For Deluge commands, provide script. For Webhook commands, provide permissions.
2 properties
base64_regex
string
Base64-encoded pagination or sync token used for cursor-based pagination and incremental data sync.
SlashCommandResponse
object
Slash Commands API response envelope.
3 properties
list-all-slash-commands-response
object
Response schema for listing slash commands.
5 properties
longid_regex
string
Numeric long integer identifier used to reference platform components such as Commands, Functions, Widgets, Message Actions, Schedulers, and Extensions.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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