Zoho Cliq Bots API

The Bots API from Zoho Cliq — 9 operation(s) for bots.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zoho Cliq Bots 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 Bots. 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 14 operations across 9 paths, and defines 21 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.

14 operations 9 paths 21 schemas 2 DELETE4 GET2 PATCH6 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

Authentication & Security 1

Zoho Cliq Bots API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.

Paths & Operations 14

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

Bots 14

POST

/bots/{BOT_UNIQUE_NAME}/calls

Trigger Bot Calls

Trigger Bot Calls 1 param body → 200400401403404405406429

POST

/bots

Create a bot

create_a_new_bot body → 200400401403404405406429

GET

/bots

List all bots

list_all_bots 3 params → 200400401403404405406429

PATCH

/bots/{BOT_ID}

Update an existing bot

update_an_existing_bot 1 param body → 200400401403404405406429

GET

/bots/{BOT_ID}

Retrieve details of a specific bot

get_details_of_a_specific_bot 2 params → 200400401403404405406429

DELETE

/bots/{BOT_ID}

Delete a specific bot

delete_a_specific_bot 1 param → 200400401403404405406429

POST

/bots/{BOT_UNIQUE_NAME}/messages

Send a bot message

send_a_bot_message 4 params body → 200

POST

/bots/{BOT_UNIQUE_NAME}/incoming

Send an incoming webhook message to a bot

send_an_incoming_webhook_message 3 params body → 200400401403404405406429

POST

/bots/{BOT_ID}/handlers

Create a handler for a specific bot

create_a_handler_for_a_bot 1 param body → 200400401403404405406429

PATCH

/bots/{BOT_ID}/handlers/{HANDLER_TYPE}

Update a handler for a specific bot

update_a_handler_for_a_bot 3 params body → 200400401403404405406429

GET

/bots/{BOT_ID}/handlers/{HANDLER_TYPE}

Get details of a specific bot handler

get_details_of_a_specific_bot_handler 3 params → 200400401403404405406429

DELETE

/bots/{BOT_ID}/handlers/{HANDLER_TYPE}

Delete a handler from a specific bot

delete_a_handler_from_a_bot 3 params → 200400401403404405406429

POST

/bots/{BOT_UNIQUE_NAME}/associate

Associate bot to a channel

associate_bot_to_channel 2 params body → 200

GET

/bots/{BOT_ID_OR_UNIQUE_NAME}/subscribers

List all subscribers of a specific bot

list_all_subscribers_of_a_bot 5 params → 200400401403404405406429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are BotMessage (16 properties), BotCreate (10 properties), BotEdit (9 properties), BotListResponse (6 properties). Each schema is shown below with its type and property counts.

BotAssociateChannelRequest

object

Payload to associate bot with a channel.

1 property

BotCreate

object

Payload for creating a new bot.

10 properties 2 required

SubAction

object

Sub-action definition for menu handlers.

2 properties 1 required

Bot-call-response

object

Represents the response returned after triggering a bot call, including the alert instance ID and associated users.

2 properties

BotGetResponse

object

Response returned when retrieving the details of a specific bot.

3 properties

BotMessage

object

Payload for sending a message from a bot. At least one of text , card , or slides must be provided. To target specific recipients, include userids (comma-separ…

16 properties

BotListResponse

object

Response schema for listing bots.

6 properties

BotUpdateResponse

object

Response returned after successfully updating a bot.

3 properties

BotHandlerCreateResponse

object

Response schema returned when a new bot handler is created successfully.

3 properties

HandlerCreate

object

Payload for creating a new handler.

6 properties 1 required

BotEdit

object

Payload for updating an existing bot. All fields are optional.

9 properties

BotHandlerDetailsResponse

object

Response schema returned when fetching the full details of a specific bot handler.

3 properties

BotSubscriber

object

Detailed information about an individual subscriber of the bot.

3 properties

BotCreateResponse

object

Response returned after successfully creating a bot.

3 properties

BotHandlerResponse

object

Response schema for bot handler create, update, and fetch operations.

3 properties

BotSubscribersResponse

object

Represents the response structure for fetching subscribers of a specific bot. Contains metadata and a list of subscriber details.

4 properties

BotIncomingWebhookResponse

object

Response returned after a successful incoming webhook message delivery. Contains the list of user IDs that received the message.

1 property

Trigger-Bot-Call-Request

object

Represents the request body for triggering a bot call with a message, recipients, retries, loops, and optional actions.

5 properties 1 required

NoResponse

object

Represents an empty successful response where no payload is returned.

1 property

BotIncomingWebhookRequest

object

Request body for the incoming webhook endpoint. Accepts any number of custom key-value parameters that are passed directly to the bot's incomingwebhookhandler…

1 property

HandlerEdit

object

Payload for updating an existing handler.

5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Zoho Cliq publishes across the network.

Zoho Cliq buttons API

AE Profile APIs.io

Zoho Cliq chats API

AE Profile APIs.io

Zoho Cliq dndsettings API

AE Profile APIs.io

Zoho Cliq Extensions API

AE Profile APIs.io

Zoho Cliq Functions API

AE Profile APIs.io

Zoho Cliq keyboardshortcuts API

AE Profile APIs.io

Zoho Cliq mentions API

AE Profile APIs.io

Zoho Cliq messageactions API

AE Profile APIs.io

Zoho Cliq messagecards API

AE Profile APIs.io

Zoho Cliq messageformat API

AE Profile APIs.io

Zoho Cliq messages API

AE Profile APIs.io

Zoho Cliq mobilesettings API

AE Profile APIs.io

#Bots

← Back to Z APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zoho Cliq Bots API

Metadata

Authentication & Security 1

Paths & Operations 14

Schemas 21

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zoho Cliq Bots API

Metadata

Authentication & Security 1

Paths & Operations 14

Schemas 21

Specification

Source

More from Zoho Cliq 12

API Details

Provider

Explore more