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

Message Actions Module

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

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

Paths & Operations 7

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

messageactions 7

Message Actions Module

POST
/messageactions
Create a new message action
create_a_new_message_action body → 200400401403404405406429
GET
/messageactions
List all message actions
list_all_message_actions 3 params → 200400401403404405406429
PATCH
/messageactions/{MESSAGE_ACTION_ID}
Update an existing message action
update_an_existing_message_act 1 param body → 200400401403404405406429
GET
/messageactions/{MESSAGE_ACTION_ID}
Get details of a specific message action
get_details_of_a_specific_mess 1 param → 200400401403404405406429
DELETE
/messageactions/{MESSAGE_ACTION_ID}
Delete a specific message action
delete_a_specific_message_acti 1 param → 204400401403404405406429
PATCH
/messageactions/{MESSAGE_ACTION_ID}/handlers/{HANDLER_TYPE}
Update a handler for a specific message action
updateMessageActionHandler 2 params body → 200400401403404405406429
GET
/messageactions/{MESSAGE_ACTION_ID}/handlers/{HANDLER_TYPE}
Get details of a specific message action handler
getMessageActionHandler 2 params → 200400401403404405406429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are v3-msgaction-create (9 properties), v3-msgaction-edit (8 properties), MessageActionListItemsResponse (5 properties), MessageActionResponse (3 properties). Each schema is shown below with its type and property counts.

MessageActionHandlerResponse
object
Response schema for message action handler operations.
3 properties
updateMessageActionHandlerResponse
object
Response schema for message action handler update operations.
3 properties
HANDLER_TYPE_regex
string
Type of the message action handler. Message actions support only one handler type: executionhandler , which is triggered when the action is invoked.
v3-exehandler-edit
object
Payload for updating the message action execution handler. For Deluge actions, provide script. For Webhook actions, provide permissions.
2 properties
base64_regex
string
Base64-encoded pagination or sync token used for cursor-based pagination and incremental data sync.
MessageActionListItemsResponse
object
Response schema for listing message actions.
5 properties
v3-msgaction-create
object
Payload for creating a message action.
9 properties 2 required
v3-msgaction-edit
object
Payload for updating a message action. All fields are optional; only the fields provided will be updated.
8 properties
longid_regex
string
Numeric long integer identifier used to reference platform components such as Commands, Functions, Widgets, Message Actions, Schedulers, and Extensions.
MessageActionUpdateResponse
object
Response schema for message action update operations.
3 properties
MessageActionResponse
object
Response schema for message action create, get, and update operations.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-cliq-messageactions-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 messagecards API
Zoho Cliq messageformat API
Zoho Cliq messages API
Zoho Cliq mobilesettings API