Zoho Cliq Platform_storage API

Manage Cliq Datastores - structured, schema-defined storage tables scoped to an organisation or extension. Datastores allow platform components to persist and query structured data across executions. Each datastore has typed fields and supports CRUD operations, field schema management, bulk record exports, and criteria-based queries.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zoho Cliq Platform_storage 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 Platform_storage. 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 16 operations across 6 paths, and defines 13 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.

16 operations 6 paths 13 schemas 4 DELETE4 GET4 PATCH4 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 Platform_storage API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Cliq_Auth) using the implicit flow, exposing 7 scopes.

Paths & Operations 16

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

Platform_storage 16

Manage Cliq Datastores - structured, schema-defined storage tables scoped to an organisation or extension. Datastores allow platform components to persist and query structured dat…

POST

/datastores

Create a datastore

creating_datastores_for_an_org body → 200400401403404405406429

GET

/datastores

List all datastores

get_list_of_datastores 3 params → 200400401403404405406429

PATCH

/datastores/{DATASTORE_ID}

Edit a datastore

edit_datastores 1 param body → 200400401403404405406429

GET

/datastores/{DATASTORE_ID}

Get a datastore

get_a_datastores 1 param → 200400401403404405406429

DELETE

/datastores/{DATASTORE_ID}

Delete a datastore

delete_a_datastore 1 param → 204400401403404405406429

PATCH

/datastores/{DATASTORE_ID}/fields

Edit datastore fields

edit_datastore_fields 1 param body → 200400401403404405406429

POST

/datastores/{DATASTORE_ID}/fields

Add fields to a datastore

add_datastore_fields 1 param body → 200400401403404405406429

DELETE

/datastores/{DATASTORE_ID}/fields

Delete fields of a datastore

delete_datastore_fields 2 params → 204400401403404405406429

PATCH

/datastores/{DATASTORE_UNIQUE_NAME}/records

Bulk update records in a datastore

update_records_in_storage 2 params body → 204400401403404405406429

POST

/datastores/{DATASTORE_UNIQUE_NAME}/records

Add records to a datastore

insert_record_in_storage 2 params body → 200400401403404405406429

GET

/datastores/{DATASTORE_UNIQUE_NAME}/records

List records from a datastore

get_records 7 params → 200400401403404405406429

DELETE

/datastores/{DATASTORE_UNIQUE_NAME}/records

Delete records from a datastore

delete_records_of_given_ids_in 4 params → 204400401403404405406429

PATCH

/datastores/{DATASTORE_UNIQUE_NAME}/records/{RECORD_ID}

Update a record in a datastore

update_a_record_in_storage 3 params body → 200400401403404405406429

GET

/datastores/{DATASTORE_UNIQUE_NAME}/records/{RECORD_ID}

Get a record from a datastore

get_a_record 3 params → 200400401403404405406429

DELETE

/datastores/{DATASTORE_UNIQUE_NAME}/records/{RECORD_ID}

Delete a record from a datastore

delete_a_record_in_storage 3 params → 204400401403404405406429

POST

/datastores/{DATASTORE_ID}/export

Export datastore records

export_datastore_records 1 param body → 204400401403404405406429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are createplatformdatabase_v2 (5 properties), editplatformdatabase_v2 (4 properties), listrecords_response (4 properties), updaterecord_response (3 properties). Each schema is shown below with its type and property counts.

listrecords_response

object

Response schema for listing records from a datastore, including pagination information and a list of records.

4 properties

edit_platform_db_fields

object

Payload for editing existing datastore fields.

1 property 1 required

datastores_records_add

object

Payload for inserting or updating a single datastore record.

1 property 1 required

updaterecord_response

object

Response envelope returned when a datastore record is retrieved or updated.

3 properties

base64_regex

string

Base64-encoded pagination or sync token used for cursor-based pagination and incremental data sync.

DatastoreResponse

object

Datastores API response envelope.

3 properties

add_platform_db_fields

object

Payload for adding new fields to a datastore schema.

1 property 1 required

platformstorage_records_export

object

Configuration payload for a Datastore bulk export operation. Specifies the fields to include, filter criteria, and output format.

3 properties 1 required

createplatformdatabase_v2

object

Payload for creating a new datastore.

5 properties 4 required

encryptedappkey_regex

string

Encrypted application key (appkey or EXTENSIONKEY) issued to a bot or extension, used as an alternative to OAuth for webhook-style authentication.

longid_regex

string

Numeric long integer identifier used to reference platform components such as Commands, Functions, Widgets, Message Actions, Schedulers, and Extensions.

editplatformdatabase_v2

object

Payload for updating datastore metadata.

4 properties

multiplelong_regex

string

Comma-separated list of numeric long integer IDs (e.g. record IDs or field IDs) used in bulk delete operations.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Zoho Cliq publishes across the network.

Zoho Cliq Bots API

AE Profile APIs.io

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

#Platform_storage

← Back to Z APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zoho Cliq Platform_storage API

Metadata

Authentication & Security 1

Paths & Operations 16

Schemas 13

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Zoho Cliq Platform_storage API

Metadata

Authentication & Security 1

Paths & Operations 16

Schemas 13

Specification

Source

More from Zoho Cliq 12

API Details

Provider

Explore more