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

APIs for sending structured interactive message cards (Poll, Modern Inline, and Prompt) inside Zoho Cliq conversations.

Zoho Cliq messagecards 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 messagecards. 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 2 operations across 2 paths, and defines 4 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.

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

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

messagecards 2

APIs for sending structured interactive message cards (Poll, Modern Inline, and Prompt) inside Zoho Cliq conversations.

POST
/channels/{CHANNEL_UNIQUE_NAME}/message
Post a message card to a channel
postMessageCardToChannel 1 param body → 200400401403404405429500
POST
/chats/{CHAT_ID}/messages
Post a message card to a chat
postMessageCardToChat 1 param body → 200400401403404405429500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CardObject (6 properties), MessageResponse (3 properties), CardButton (2 properties). Each schema is shown below with its type and property counts.

CardObject
object
Defines the interactive card to be rendered inside the message. The theme field selects the card type and determines which fields are required. For a quick ref…
6 properties 2 required
MessageResponse
object
Response returned after a message card is successfully posted.
3 properties
Slides
array
An array of structured content blocks rendered below the card inside the message. slides is a top-level field in the message payload - it sits alongside text a…
CardButton
object
An action button rendered inside a Message Card. When clicked by a user, the button executes the specified action .
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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