Zoho Cliq REST API v2

https://www.zoho.com/cliq/help/restapi/v2
Admin
Zoho Cliq REST API v2 provides endpoints for managing users, departments, roles, chats, and channels...
Tokens:342,701
Snippets:1,830
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Bulk Export API Request Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/bulkexport

Examples demonstrating how to perform a GET request to the Bulk Export API across multiple programming languages.

```Deluge
headers_data = Map(); headers_data.put("Content-Type", "text/csv"); headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=SOME_STRING_VALUE" type: GET headers: headers_data connection: <connection_name> ]; info response;
```

```Java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id") .get() .addHeader("Content-Type", "text/csv") .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

```JavaScript
const options = { method: 'GET', headers: { 'Content-Type': 'text/csv', Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```Python
import http.client  conn = http.client.HTTPSConnection("cliq.zoho.com")  headers = { 'Content-Type': "text/csv", 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }  conn.request("GET", "/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id", headers=headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```Node.js
const http = require("https"); const options = { "method": "GET", "hostname": "cliq.zoho.com", "port": null, "path": "/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id", "headers": { "Content-Type": "text/csv", "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();
```

```C#
var client = new RestClient("https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id"); var request = new RestRequest(Method.GET); request.AddHeader("Content-Type", "text/csv"); request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); IRestResponse response = client.Execute(request);
```

```C#
var client = new HttpClient(); var request = new HttpRequestMessage {     Method = HttpMethod.Get,     RequestUri = new Uri("https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id"),     Headers = { { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }, }, }; using (var response = await client.SendAsync(request)) {     response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync();     Console.WriteLine(body); }
```

```Go
package main  import ( "fmt" "net/http" "io/ioutil" ) func main() {  	url := "https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id"  	req, _ := http.NewRequest("GET", url, nil)  	req.Header.Add("Content-Type", "text/csv") 	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)) }
```

```JavaScript
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/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id"); xhr.setRequestHeader("Content-Type", "text/csv"); xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");  xhr.send(data);
```

```Shell
curl --request GET \
 --url 'https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats/CHAT_ID/members?fields=name%2Cemail_id' \
 --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
 --header 'Content-Type: text/csv'
```

--------------------------------

### Execute Bulk Export Request

Source: https://www.zoho.com/cliq/help/restapi/v2/bulkexport

Examples demonstrating how to perform a GET request to the bulk export endpoint with required headers.

```Deluge
headers_data = Map(); headers_data.put("Content-Type", "text/csv"); headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats?fields=SOME_STRING_VALUE" type: GET headers: headers_data connection: <connection_name> ]; info response;
```

```Java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id") .get() .addHeader("Content-Type", "text/csv") .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

```JavaScript (Fetch)
const options = { method: 'GET', headers: { 'Content-Type': 'text/csv', Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```Python
import http.client  conn = http.client.HTTPSConnection("cliq.zoho.com")  headers = { 'Content-Type': "text/csv", 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }  conn.request("GET", "/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id", headers=headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```Node.js
const http = require("https"); const options = { "method": "GET", "hostname": "cliq.zoho.com", "port": null, "path": "/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id", "headers": { "Content-Type": "text/csv", "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();
```

```C# (RestSharp)
var client = new RestClient("https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id"); var request = new RestRequest(Method.GET); request.AddHeader("Content-Type", "text/csv"); request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); IRestResponse response = client.Execute(request);
```

```C# (HttpClient)
var client = new HttpClient(); var request = new HttpRequestMessage {     Method = HttpMethod.Get,     RequestUri = new Uri("https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id"),     Headers = { { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }, }, }; using (var response = await client.SendAsync(request)) {     response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync();     Console.WriteLine(body); }
```

```Go
package main  import ( "fmt" "net/http" "io/ioutil" ) func main() {  	url := "https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id"  	req, _ := http.NewRequest("GET", url, nil)  	req.Header.Add("Content-Type", "text/csv") 	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)) }
```

```JavaScript (XHR)
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/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id"); xhr.setRequestHeader("Content-Type", "text/csv"); xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");  xhr.send(data);
```

```cURL
curl --request GET \
 --url 'https://cliq.zoho.com/company/COMPANY_ID/maintenanceapi/v2/chats?fields=title%2Cchat_id' \
 --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
 --header 'Content-Type: text/csv'
```

--------------------------------

### Retrieve Custom Theme via GET Request

Source: https://www.zoho.com/cliq/help/restapi/v2/customthemes

Examples for fetching theme data using the GET method across multiple programming environments.

```Deluge
headers_data = Map(); headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://cliq.zoho.com/api/v2/themes/THEME_NAME" type: GET headers: headers_data connection: <connection_name> ]; info response;
```

```Java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://cliq.zoho.com/api/v2/themes/THEME_NAME") .get() .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

```JavaScript (Fetch)
const options = { method: 'GET', headers: { Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://cliq.zoho.com/api/v2/themes/THEME_NAME', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```Python
import http.client  conn = http.client.HTTPSConnection("cliq.zoho.com")  headers = { 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }  conn.request("GET", "/api/v2/themes/THEME_NAME", headers=headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```Node.js
const http = require("https"); const options = { "method": "GET", "hostname": "cliq.zoho.com", "port": null, "path": "/api/v2/themes/THEME_NAME", "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();
```

```C# (RestSharp)
var client = new RestClient("https://cliq.zoho.com/api/v2/themes/THEME_NAME"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); IRestResponse response = client.Execute(request);
```

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

```Go
package main  import ( "fmt" "net/http" "io/ioutil" ) func main() {  	url := "https://cliq.zoho.com/api/v2/themes/THEME_NAME"  	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)) }
```

```JavaScript (XHR)
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/v2/themes/THEME_NAME"); xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");  xhr.send(data);
```

```cURL
curl --request GET \
 --url https://cliq.zoho.com/api/v2/themes/THEME_NAME \
 --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
```

--------------------------------

### List All Functions

Source: https://www.zoho.com/cliq/help/restapi/v2/glossary

Example response for a GET request to list all functions, showing the structure of function objects including their unique IDs.

```json
{
  "url": "/api/v3/functions",
  "next_token": "NTB8LTF8NTM3MTkwMDAwMDAyNDUwMTE=",
  "type": "function",
  "sync_token": "NTB8MTc3NzQzMjg2NjI1MXw1MzcxOTAwMDAwMjEyNDAxMQ==",
  "data": [
    {
      "name": "createTask",
      "id": "53719000002124011",
      "function_type": "button",
      "handlers": [
        {
          "type": "button_handler"
        }
      ],
      "creator": {
        "name": "James",
        "id": "65113112"
      },
      "execution_type": "deluge",
      "status": "enabled",
      "type": "custom",
      "description": "Creates a task in integrated system",
      "scope": "personal"
    },
    {
      "name": "SubmitFeedback",
      "id": "53719000002124012",
      "function_type": "form",
      "handlers": [
        {
          "type": "form_submit_handler"
        }
      ],
      "creator": {
        "name": "James",
        "id": "65113112"
      },
      "execution_type": "deluge",
      "status": "enabled",
      "type": "custom",
      "description": "Processes feedback form submissions from users",
      "scope": "personal"
    }
  ]
}
```

--------------------------------

### Create Event Implementation Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/events

Code examples for creating an event using different programming languages.

```deluge
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/v2/events" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```java
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/v2/events") .post(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```javascript
const options = { method: 'POST', headers: { Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://cliq.zoho.com/api/v2/events', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Retrieve File Information via REST API

Source: https://www.zoho.com/cliq/help/restapi/v2/files

Examples for fetching file details using the GET method with an Authorization header.

```Deluge
headers_data = Map(); headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://cliq.zoho.com/api/v2/files/FILE_ID" type: GET headers: headers_data connection: <connection_name> ]; info response;
```

```Java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://cliq.zoho.com/api/v2/files/FILE_ID") .get() .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

```JavaScript
const options = { method: 'GET', headers: { Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://cliq.zoho.com/api/v2/files/FILE_ID', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```Python
import http.client  conn = http.client.HTTPSConnection("cliq.zoho.com")  headers = { 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }  conn.request("GET", "/api/v2/files/FILE_ID", headers=headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```Node.js
const http = require("https"); const options = { "method": "GET", "hostname": "cliq.zoho.com", "port": null, "path": "/api/v2/files/FILE_ID", "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();
```

```C#
var client = new RestClient("https://cliq.zoho.com/api/v2/files/FILE_ID"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); IRestResponse response = client.Execute(request);
```

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

```Go
package main  import ( "fmt" "net/http" "io/ioutil" ) func main() {  	url := "https://cliq.zoho.com/api/v2/files/FILE_ID"  	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)) }
```

```JavaScript
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/v2/files/FILE_ID"); xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");  xhr.send(data);
```

```Shell
curl --request GET \
 --url https://cliq.zoho.com/api/v2/files/FILE_ID \
 --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
```

--------------------------------

### Update Userfield Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/userfields

Examples for updating a userfield using different programming languages.

```deluge
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/v2/userfields/FIELD_ID" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```java
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/v2/userfields/FIELD_ID") .put(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```javascript
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/v2/userfields/FIELD_ID', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Update Reminder Implementation Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/reminders

Code examples for updating a reminder using various programming languages and HTTP clients.

```deluge
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/v2/reminders/REMINDER_ID" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```java
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/v2/reminders/REMINDER_ID") .put(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```javascript
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/v2/reminders/REMINDER_ID', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```python
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/v2/reminders/REMINDER_ID", payload, headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```node.js
const http = require("https"); const options = { "method": "PUT", "hostname": "cliq.zoho.com", "port": null, "path": "/api/v2/reminders/REMINDER_ID", "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();
```

--------------------------------

### Update Record Implementation Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/databases

Code examples for updating a record using various programming languages and libraries.

```deluge
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/v2/storages/DATABASE_UNIQUE_NAME/records/RECORD_ID" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```java
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/v2/storages/DATABASE_UNIQUE_NAME/records/RECORD_ID") .put(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```javascript
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/v2/storages/DATABASE_UNIQUE_NAME/records/RECORD_ID', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```python
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/v2/storages/DATABASE_UNIQUE_NAME/records/RECORD_ID", payload, headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Body Parameters Example

Source: https://www.zoho.com/cliq/help/restapi/v2/customemail

Example JSON payload for the request body.

```JSON
{ "name": "Scott", "email_id": "scott.fisher@zylkerorg.gq", "cname_status": "verified", "dkim_key_size": 2048 }
```

--------------------------------

### Post Message API Request Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/messages

Examples of how to send a message to a user using various programming languages.

```deluge
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/v2/buddies/ZUID/message" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```java
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/v2/buddies/ZUID/message") .post(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```javascript
const options = { method: 'POST', headers: { Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://cliq.zoho.com/api/v2/buddies/ZUID/message', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```python
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("POST", "/api/v2/buddies/ZUID/message", payload, headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```node.js
const http = require("https"); const options = { "method": "POST", "hostname": "cliq.zoho.com", "port": null, "path": "/api/v2/buddies/ZUID/message", "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();
```

--------------------------------

### Update Theme Request Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/customthemes

Code examples for updating a theme using various programming languages and libraries.

```deluge
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/v2/themes/THEME_NAME" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```java
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/v2/themes/THEME_NAME") .put(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```javascript
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/v2/themes/THEME_NAME', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```python
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/v2/themes/THEME_NAME", payload, headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```node.js
const http = require("https"); const options = { "method": "PUT", "hostname": "cliq.zoho.com", "port": null, "path": "/api/v2/themes/THEME_NAME", "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();
```

```csharp
var client = new RestClient("https://cliq.zoho.com/api/v2/themes/THEME_NAME"); 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);
```

--------------------------------

### API Response Example

Source: https://www.zoho.com/cliq/help/restapi/v2/bulkexport

Example of a successful JSON response from the API.

```json
{ "data": [ { "name": "Scott Fisher", "email": "scott.fisher@zylker.com" }, { "name": "Ryan West", "email": "ryan.west@zylker.com" }, { "name": "Olivia Palmer", "email": "olivia.palmer@zylker.com" } ] }
```

--------------------------------

### Post Message API Request Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/messages

Examples of how to post a message to a channel using different programming languages.

```deluge
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/v2/channels/CHANNEL_ID/message" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```java
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/v2/channels/CHANNEL_ID/message") .post(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```javascript
const options = { method: 'POST', headers: { Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://cliq.zoho.com/api/v2/channels/CHANNEL_ID/message', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Perform a GET request to retrieve chats

Source: https://www.zoho.com/cliq/help/restapi/v2/errors

Example of a standard GET request using cURL with an OAuth token.

```bash
$ curl -X GET "https://cliq.zoho.com/api/v2/chats" \ -H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxxxxxxxxx"
```

--------------------------------

### Add Users to Role API Request Examples

Source: https://www.zoho.com/cliq/help/restapi/v2/roles

Examples for adding users to a role using various programming languages and libraries.

```Deluge
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/v2/profiles/PROFILE_ID/users" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
```

```Java
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/v2/profiles/PROFILE_ID/users") .post(body) .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
```

```Javascript
const options = { method: 'POST', headers: { Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://cliq.zoho.com/api/v2/profiles/PROFILE_ID/users', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

```Python
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("POST", "/api/v2/profiles/PROFILE_ID/users", payload, headers)  res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

```Node.js
const http = require("https"); const options = { "method": "POST", "hostname": "cliq.zoho.com", "port": null, "path": "/api/v2/profiles/PROFILE_ID/users", "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();
```

```C#
var client = new RestClient("https://cliq.zoho.com/api/v2/profiles/PROFILE_ID/users"); var request = new RestRequest(Method.POST); 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);
```
Tokens:
Raw