User Preferences AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

The User Preferences API allows users to retrieve and update personal Zoho Cliq preferences, including interface behavior, notifications, AV settings, and accessibility options.

Download User Preferences OpenAPI Document

End Points

PUT

/settings/user-preferences

GET

/settings/user-preferences

Update user preferences AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Updates one or more user preferences for the authenticated user. Send only the fields you want to modify.

OAuth Scope: ZohoCliq.Profile.UPDATE

OAuth Scope : ZohoCliq.Profile.UPDATE

Arguments

dark_mode

string

Toggles dark mode for the Cliq interface.
Allowed values:

enabled: Dark mode is active.
disabled: Dark mode is turned off.

ui_theme

string

Active UI theme identifier.

lhs_theme

string

Toggles the left-hand sidebar theme.
Allowed values:

enabled: Left-hand sidebar theme is applied.
disabled: Left-hand sidebar theme is turned off.

smileys

string

Toggles emoji display in messages.
Allowed values:

enabled: Emojis are rendered in messages.
disabled: Emojis are shown as text.

translation_mode

string

Toggles automatic message translation.
Allowed values:

enabled: Auto-translation is active.
disabled: Auto-translation is turned off.

av_noise_cancellation

string

Toggles noise cancellation during audio/video calls.
Allowed values:

enabled: Noise cancellation is active.
disabled: Noise cancellation is turned off.

av_hd_video

string

Toggles HD video during calls.
Allowed values:

enabled: HD video is active.
disabled: HD video is turned off.

sound_notification

string

Master toggle for all sound notifications.
Allowed values:

enabled: Sound notifications are active.
disabled: All sound notifications are muted.

desktop_notification

string

Toggles desktop push notifications.
Allowed values:

enabled: Desktop notifications are active.
disabled: Desktop notifications are turned off.

reading_mask

string

Toggles reading mask for accessibility.
Allowed values:

enabled: Reading mask is active.
disabled: Reading mask is turned off.

vision_assistive

string

Toggles vision assistive features.
Allowed values:

enabled: Vision assistive features are active.
disabled: Vision assistive features are turned off.

cliq_font

string

Selected font identifier. -1 means default.

cliq_font_size

string

Font size level.

conference_recording

string

Toggles conference call recording.
Allowed values:

enabled: Conference recording is permitted.
disabled: Conference recording is not permitted.

video_background

string

Virtual background identifier for video calls.

video_filter

string

Video filter identifier applied during calls.

last_seen

string

Controls the visibility of the user's last seen status.
Allowed values:

enabled: Last seen is visible to contacts.
disabled: Last seen is hidden from contacts.

linkpreview_status

string

Toggles URL link previews in messages.
Allowed values:

enabled: Link previews are shown in messages.
disabled: Link previews are hidden.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v3/settings/user-preferences"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v3/settings/user-preferences")
  .put(body)
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://cliq.zoho.com/api/v3/settings/user-preferences', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/api/v3/settings/user-preferences", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v3/settings/user-preferences",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

var client = new RestClient("https://cliq.zoho.com/api/v3/settings/user-preferences");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://cliq.zoho.com/api/v3/settings/user-preferences"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v3/settings/user-preferences"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://cliq.zoho.com/api/v3/settings/user-preferences");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request PUT \
  --url https://cliq.zoho.com/api/v3/settings/user-preferences \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "dark_mode": "enabled",
    "ui_theme": "4",
    "lhs_theme": "enabled",
    "smileys": "enabled",
    "translation_mode": "enabled",
    "av_noise_cancellation": "enabled",
    "av_hd_video": "enabled",
    "sound_notification": "enabled",
    "desktop_notification": "enabled",
    "reading_mask": "enabled",
    "vision_assistive": "enabled",
    "cliq_font": "-1",
    "cliq_font_size": "2",
    "conference_recording": "enabled",
    "video_background": "none",
    "video_filter": "none",
    "last_seen": "enabled",
    "linkpreview_status": "enabled"
}

Response Example

{
    "status": "success",
    "message": "Operation completed successfully."
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

Get user preferences AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Returns the full preference set for the authenticated user. This includes interface settings, notification controls, AV behavior, and accessibility-related options.

OAuth Scope: ZohoCliq.Profile.READ

OAuth Scope : ZohoCliq.Profile.READ

Query Parameters

keys

string

Comma-separated preference key names to fetch.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v3/settings/user-preferences"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v3/settings/user-preferences")
  .get()
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://cliq.zoho.com/api/v3/settings/user-preferences', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

headers = { 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v3/settings/user-preferences", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v3/settings/user-preferences",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://cliq.zoho.com/api/v3/settings/user-preferences");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://cliq.zoho.com/api/v3/settings/user-preferences"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v3/settings/user-preferences"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://cliq.zoho.com/api/v3/settings/user-preferences");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url https://cliq.zoho.com/api/v3/settings/user-preferences \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "userpreferences": {
        "dark_mode": "enabled",
        "ui_theme": "4",
        "lhs_theme": "enabled",
        "smileys": "enabled",
        "smileypreference": "enabled",
        "translation_mode": "enabled",
        "show_translate_option": "enabled",
        "av_noise_cancellation": "enabled",
        "av_hd_video": "enabled",
        "av_speech_detection": "enabled",
        "av_auto_pip": "enabled",
        "av_livetranscript_always_on": "enabled",
        "av_livetranscript_fontsize": "2",
        "av_translate_livetranscript": "enabled",
        "sound_notification": "enabled",
        "global_sound_notify": "enabled",
        "desktop_notification": "enabled",
        "toast_notification": "enabled",
        "reading_mask": "enabled",
        "reading_mask_type": "enabled",
        "vision_assistive": "enabled",
        "vision_assistive_type": "enabled",
        "cliq_font": "-1",
        "cliq_font_size": "2",
        "cliq_font_spacing": "2",
        "reminder_notification": "enabled",
        "reactions_notification": "enabled",
        "quick_reactions": ":thumbsup:,:super:,:heavy-plus-sign:",
        "conference_recording": "enabled",
        "conference_theme": "none",
        "video_background": "none",
        "video_filter": "none",
        "contact_photo": "enabled",
        "linkpreview_status": "enabled",
        "underlinelinks": "enabled",
        "magnify_text": "enabled",
        "focus_indicator": "enabled",
        "last_seen": "enabled",
        "message_in_notification": "enabled",
        "huddle_mirror_video": "enabled",
        "huddle_pane_status": "enabled",
        "huddle_sticky_info": "enabled",
        "huddle_screenshare_layout": "enabled",
        "huddle_notify_msg": "enabled"
    }
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

User Preferences AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Update user preferences AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Get user preferences AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

User Preferences AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update user preferences AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get user preferences AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab