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

User Preferences Module

Zoho Cliq userpreferences 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 userpreferences. 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 1 path, 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 1 paths 4 schemas 1 GET1 PUT

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 userpreferences 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 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

userpreferences 2

User Preferences Module

GET
/settings/user-preferences
Get user preferences
getUserPreferences 1 param → 200400401403429500
PUT
/settings/user-preferences
Update user preferences
updateUserPreferences body → 204400401403429500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are user-preferences-object (44 properties), update-user-preferences-request (18 properties), NoResponse (2 properties), user-preferences-response (1 property). Each schema is shown below with its type and property counts.

update-user-preferences-request
object
Provide only the preference fields that must be updated.
18 properties
user-preferences-response
object
1 property
user-preferences-object
object
Complete user preference object returned by the API.
44 properties
NoResponse
object
Response envelope for successful operations with no payload.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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