Scheduled Messages 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 Scheduled Messages API gets a powerful upgrade with v3, giving developers full lifecycle control over message delivery to build time-aware and context-driven communication workflows. Messages can be composed in advance and delivered automatically based on a scheduled time or a participant's status change, all within the scope of a specific chat.

Key Capabilities

List Scheduled Messages: Query all scheduled messages globally or within a specific chat to monitor and audit pending deliveries.
Send Now: Override the scheduled trigger and immediately deliver a single message or all pending messages within a chat.
Bulk Reschedule: Perform a single-operation update to the delivery time or status trigger across all scheduled messages in a chat, enabling scalable schedule management.
Edit Message: Update message content, delivery time, timezone, status-based trigger, or remove an attached file from any individual scheduled message.
Delete: Remove a specific scheduled message or clear the entire scheduled message queue from a chat.

Scheduling Modes

Mode	Field	Description
`Time-based`	`schedule_time` + `schedule_timezone`	Delivers at a fixed date and time. Time must be provided in epoch milliseconds.
`Status-based`	`schedule_status`	Delivers when the sender's status matches a trigger: `check_in`, `check_out`, `user_available`, or `call_end`.

Download Scheduled Messages OpenAPI Document

End Points

GET

/scheduledmessages

POST

/chats/{CHAT_ID}/scheduledmessages

PUT

/chats/{CHAT_ID}/scheduledmessages

GET

/chats/{CHAT_ID}/scheduledmessages

DELETE

/chats/{CHAT_ID}/scheduledmessages

PUT

/chats/{CHAT_ID}/scheduledmessages/{SCHEDULED_MESSAGE_ID}

DELETE

/chats/{CHAT_ID}/scheduledmessages/{SCHEDULED_MESSAGE_ID}

List all scheduled messages 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

Retrieves all scheduled messages across all chats for the authenticated user. Use this to get a consolidated view of all pending time-based and status-based scheduled messages, with support for pagination and incremental updates.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

OAuth Scope : ZohoCliq.Messages.READ

Query Parameters

limit

integer

Number of results per page. Default is 50.
Maximum limit: 100

next_token

string

Pagination cursor returned from a previous response. Pass this value to retrieve the next page of results.

sync_token

string

Token from a previous response used to fetch only changes since the last sync. Pass this to retrieve only new or updated records instead of the full list.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v3/scheduledmessages"
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/scheduledmessages")
  .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/scheduledmessages', 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/scheduledmessages", 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/scheduledmessages",
  "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/scheduledmessages");
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/scheduledmessages"),
    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/scheduledmessages"

	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/scheduledmessages");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

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

Response Example

{
    "url": "/api/v3/scheduledmessages",
    "type": "scheduledmessages",
    "sync_token": "NTB8LTF8MTkwMTMxODAwMDAxMjMxNDAyNQ==",
    "data": [
        {
            "id": "84fe7397-ab35-4aef-8bf7-944d688857af",
            "timezone": "Asia/Kolkata",
            "created_time": "2026-05-29T04:27:40-07:00",
            "schedule_status": "user_available",
            "message": {
                "sender": {
                    "name": "Priya",
                    "id": "697322516"
                },
                "type": "text",
                "content": {
                    "text": "Hi Benjamin, just a quick nudge. Please update the approval status for Claim #EXP-2026-0412 when you are available. No rush, respond whenever you are free!"
                },
                "is_pinned": false
            },
            "creator": {
                "name": "Priya",
                "id": "697322516"
            }
        },
        {
            "id": "49ba8eac-8709-478d-bab3-701466b3e270",
            "timezone": "Asia/Kolkata",
            "created_time": "2026-05-29T04:28:44-07:00",
            "schedule_status": "check_in",
            "message": {
                "sender": {
                    "name": "Priya",
                    "id": "697322516"
                },
                "type": "text",
                "content": {
                    "text": "Good morning Alan! Just a check-in reminder, please update your pending expense claims before the daily finance standup. Any blockers, ping @financeTeam."
                },
                "is_pinned": false
            },
            "creator": {
                "name": "Priya",
                "id": "697322516"
            }
        },
        {
            "id": "de8518c4-ce33-46c1-9195-d7864b9f10ce",
            "timezone": "Asia/Kolkata",
            "created_time": "2026-05-29T04:31:33-07:00",
            "time": "2026-06-06T21:00:00-07:00",
            "message": {
                "sender": {
                    "name": "Priya",
                    "id": "697322516"
                },
                "type": "file",
                "content": {
                    "file_name": "Expense Summary - Zylker.pdf",
                    "file_size": "61.05 KB",
                    "comment": "Please find the attached Q2 Expense Summary report. Review before the finance sync on June 6 and flag any discrepancies to @financeTeam."
                },
                "is_pinned": false
            },
            "creator": {
                "name": "Priya",
                "id": "697322516"
            }
        }
    ]
}

{
    "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."
}

Send scheduled messages now 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

Immediately sends one or all pending scheduled messages in a chat without waiting for the scheduled time. Use this to manually trigger delivery of a specific message by ID, or all pending messages in the chat at once.

Threshold limit: 50 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

! Possible Error Codes Click to expand

Error Code	Description
scheduled_msg_no_pending_msgs	No pending scheduled messages exist in this chat.
param_missing	A required parameter is missing from the request.

Error Response Format

When an error occurs, the API returns a JSON response in this format:

{"message": "A human-readable description of the error.", "code": "error_code"}

where code is the error identifier (as listed above) and message is a human-readable explanation of what went wrong.

OAuth Scope : ZohoCliq.Messages.CREATE

Arguments

status

string

(Required)

Operation trigger to send messages immediately.
Allowed values:

send: Triggers immediate delivery of the specified scheduled message or all pending messages in the chat.

string

Unique identifier of a specific scheduled message to send immediately. When provided, only that message is sent.
Omit this field and use apply_to instead to send all pending messages.

apply_to

string

Scope of messages to send when no id is provided.
Allowed values:

all: Sends all pending scheduled messages in the chat immediately.

Path Parameters

CHAT_ID

string

(Required)

Unique identifier of the chat or channel. Determines which chat's scheduled messages are targeted for immediate delivery.
To learn how to retrieve this ID, see CHAT_ID in the Glossary page.

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/chats/CHAT_ID/scheduledmessages"
type: POST
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/chats/CHAT_ID/scheduledmessages")
  .post(body)
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

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

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/v3/chats/CHAT_ID/scheduledmessages', 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("POST", "/api/v3/chats/CHAT_ID/scheduledmessages", payload, headers)

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

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

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v3/chats/CHAT_ID/scheduledmessages",
  "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/chats/CHAT_ID/scheduledmessages");
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);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages"),
    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/chats/CHAT_ID/scheduledmessages"

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

	req, _ := http.NewRequest("POST", 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("POST", "https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

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

{
    "status": "send",
    "id": "76d3978e-b782-4cbb-a98b-670a5a7cbc6e"
}

{
    "status": "send",
    "apply_to": "all"
}

Response Example

{
    "Response Code": "204 No response"
}

{
    "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": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

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

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

Bulk reschedule scheduled messages 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

Reschedules all time-based or status-based scheduled messages in a chat in a single operation. Use this to update delivery times or change status triggers across multiple messages at once without editing them individually.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

! Possible Error Codes Click to expand

Error Code	Description
param_missing	A required parameter is missing from the request.
scheduled_msg_no_pending_msgs	No pending scheduled messages exist in this chat.
scheduled_msg_invalid_time_format	Invalid `schedule_time` format. Expected epoch milliseconds.
input_pattern_mismatch	An unrecognized value was passed for an enum field.

Error Response Format

When an error occurs, the API returns a JSON response in this format:

{"message": "A human-readable description of the error.", "code": "error_code"}

where code is the error identifier (as listed above) and message is a human-readable explanation of what went wrong.

OAuth Scope : ZohoCliq.Messages.UPDATE

Arguments

status

string

(Required)

Operation type for this request.
Allowed values:

reschedule: Triggers a bulk rescheduling operation for all matching messages in the chat. Use apply_to to specify the message type to target.

apply_to

string

Scope of scheduled messages to update in this operation.
Allowed values:

all_time_based: Targets all time-based scheduled messages that match the time field. Requires time and schedule_time.
all_status_based: Targets all status-based scheduled messages that match the existing_status field. Requires existing_status and schedule_status.

time

long

Existing scheduled delivery time to match, in epoch milliseconds. Required when apply_to is all_time_based.
Only messages scheduled at this exact time will be updated.

schedule_time

long

New delivery time to apply to all matched messages, in epoch milliseconds. Required when apply_to is all_time_based.

schedule_timezone

string

Timezone to apply for time fields. Example: Asia/Kolkata.
Maximum length: 100 characters.

existing_status

string

Current status trigger to match for bulk update. Required when apply_to is all_status_based.
Allowed values:

check_in: Matches messages scheduled to send when the sender checks in.
check_out: Matches messages scheduled to send when the sender checks out.
user_available: Matches messages scheduled to send when the sender becomes available.
call_end: Matches messages scheduled to send when the sender ends a call.

schedule_status

string

New status trigger to apply to all matched messages. Required when apply_to is all_status_based.
Allowed values:

check_in: Delivers the message when the sender checks in.
check_out: Delivers the message when the sender checks out.
user_available: Delivers the message when the sender becomes available.
call_end: Delivers the message when the sender ends a call.

Path Parameters

CHAT_ID

string

(Required)

Unique identifier of the chat or channel. All matching scheduled messages within this chat will be updated by the bulk reschedule operation.
To learn how to retrieve this ID, see CHAT_ID in the Glossary page.

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/chats/CHAT_ID/scheduledmessages"
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/chats/CHAT_ID/scheduledmessages")
  .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/chats/CHAT_ID/scheduledmessages', 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/chats/CHAT_ID/scheduledmessages", 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/chats/CHAT_ID/scheduledmessages",
  "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/chats/CHAT_ID/scheduledmessages");
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/chats/CHAT_ID/scheduledmessages"),
    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/chats/CHAT_ID/scheduledmessages"

	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/chats/CHAT_ID/scheduledmessages");
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/chats/CHAT_ID/scheduledmessages \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

Body Parameters

{
    "status": "reschedule",
    "apply_to": "all_time_based",
    "time": 1748861400000,
    "schedule_time": 1748947800000,
    "schedule_timezone": "Asia/Kolkata"
}

{
    "status": "reschedule",
    "apply_to": "all_status_based",
    "existing_status": "check_in",
    "schedule_status": "user_available"
}

Response Example

{
    "url": "/api/v3/chats/CT_1424569695482328362_631836344/scheduledmessages",
    "type": "scheduledmessages",
    "data": [
        {
            "id": "3574bbf2-77ed-4b9c-99d9-8d487d6f8d11",
            "timezone": "Asia/Kolkata",
            "created_time": "2026-05-29T03:15:49-07:00",
            "time": "2026-06-02T20:30:00-07:00",
            "message": {
                "sender": {
                    "name": "Priya",
                    "id": "697322516"
                },
                "type": "text",
                "content": {
                    "text": "Q2 Expense Report Deadline [UPDATED]: Submission extended to June 6. Ensure all vendor invoices above $500 have manager approval. Contact @financeTeam for help."
                },
                "is_pinned": false
            },
            "creator": {
                "name": "Priya",
                "id": "697322516"
            }
        }
    ]
}

{
    "url": "/api/v3/chats/2242125276857119940/scheduledmessages",
    "type": "scheduledmessages",
    "data": [
        {
            "id": "49ba8eac-8709-478d-bab3-701466b3e270",
            "timezone": "Asia/Kolkata",
            "created_time": "2026-05-29T04:28:44-07:00",
            "schedule_status": "user_available",
            "message": {
                "sender": {
                    "name": "Priya",
                    "id": "697322516"
                },
                "type": "text",
                "content": {
                    "text": "Good morning Alan! Just a check-in reminder, please update your pending expense claims before the daily finance standup. Any blockers, ping @financeTeam."
                },
                "is_pinned": false
            },
            "creator": {
                "name": "Priya",
                "id": "697322516"
            }
        }
    ]
}

{
    "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."
}

List scheduled messages in a chat 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

Retrieves all scheduled messages within a specific chat or channel. Use this to inspect pending time-based and status-based messages for a particular conversation, with support for pagination and incremental updates.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

OAuth Scope : ZohoCliq.Messages.READ

Path Parameters

CHAT_ID

string

(Required)

Unique identifier of the chat or channel. Use this to scope the scheduled messages retrieval to a specific conversation.
To learn how to retrieve this ID, see CHAT_ID in the Glossary page.

Query Parameters

limit

integer

Number of results per page. Default is 50.
Maximum limit: 100

next_token

string

Pagination cursor returned from a previous response. Pass this value to retrieve the next page of results.

sync_token

string

Token from a previous response used to fetch only changes since the last sync. Pass this to retrieve only new or updated records instead of the full list.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages"
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/chats/CHAT_ID/scheduledmessages")
  .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/chats/CHAT_ID/scheduledmessages', 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/chats/CHAT_ID/scheduledmessages", 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/chats/CHAT_ID/scheduledmessages",
  "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/chats/CHAT_ID/scheduledmessages");
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/chats/CHAT_ID/scheduledmessages"),
    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/chats/CHAT_ID/scheduledmessages"

	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/chats/CHAT_ID/scheduledmessages");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "url": "/api/v3/chats/CT_1424569695482328362_631836344/scheduledmessages",
    "type": "scheduledmessages",
    "sync_token": "NTB8MTc4MDM2NzQwMDAwMHwxOTAxMzE4MDAwMDEyNjUxMDAx",
    "data": [
        {
            "id": "de8518c4-ce33-46c1-9195-d7864b9f10ce",
            "timezone": "Asia/Kolkata",
            "created_time": "2026-05-29T04:31:33-07:00",
            "time": "2026-06-06T21:00:00-07:00",
            "message": {
                "sender": {
                    "name": "Priya",
                    "id": "697322516"
                },
                "type": "file",
                "content": {
                    "file_name": "Expense Summary - Zylker.pdf",
                    "file_size": "61.05 KB",
                    "comment": "Please find the attached Q2 Expense Summary report. Review before the finance sync on June 6 and flag any discrepancies to @financeTeam."
                },
                "is_pinned": false
            },
            "creator": {
                "name": "Priya",
                "id": "697322516"
            }
        }
    ]
}

{
    "url": "/api/v3/chats/1424921584119739269/scheduledmessages",
    "type": "scheduledmessages",
    "sync_token": "NTB8MTc4MDA0OTAzNDg4MHw=",
    "data": [
        {
            "id": "84fe7397-ab35-4aef-8bf7-944d688857af",
            "timezone": "Asia/Kolkata",
            "created_time": "2026-05-29T04:27:40-07:00",
            "schedule_status": "user_available",
            "message": {
                "sender": {
                    "name": "Priya",
                    "id": "697322516"
                },
                "type": "text",
                "content": {
                    "text": "Hi Benjamin, just a quick nudge. Please update the approval status for Claim #EXP-2026-0412 when you are available. No rush, respond whenever you are free!"
                },
                "is_pinned": false
            },
            "creator": {
                "name": "Priya",
                "id": "697322516"
            }
        }
    ]
}

{
    "url": "/api/v3/chats/1608865438186287622/scheduledmessages",
    "type": "scheduledmessages",
    "sync_token": "NTB8MTc4MDA0OTAzNDg4MHw=",
    "data": []
}

{
    "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."
}

Delete all scheduled messages in a chat 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

Deletes all scheduled messages in a chat in a single operation. Use this to clear all pending scheduled messages from a conversation at once without deleting them individually.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

OAuth Scope : ZohoCliq.Messages.DELETE

Path Parameters

CHAT_ID

string

(Required)

Unique identifier of the chat or channel. All scheduled messages within this chat will be permanently removed.
To learn how to retrieve this ID, see CHAT_ID in the Glossary page.

Request Example

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

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages")
  .delete(null)
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

fetch('https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages', 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("DELETE", "/api/v3/chats/CHAT_ID/scheduledmessages", headers=headers)

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

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

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v3/chats/CHAT_ID/scheduledmessages",
  "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/chats/CHAT_ID/scheduledmessages");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages"),
    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/chats/CHAT_ID/scheduledmessages"

	req, _ := http.NewRequest("DELETE", 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("DELETE", "https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request DELETE \
  --url https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "Response Code": "204 No response"
}

{
    "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."
}

Edit a scheduled message 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 the text, scheduled time, timezone, status trigger, or file attachment of an existing scheduled message. Use this to modify a specific scheduled message before it is delivered, including switching between time-based and status-based scheduling.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

! Possible Error Codes Click to expand

Error Code	Description
scheduled_msg_not_found	The requested scheduled message could not be found.
scheduled_msg_invalid_time_format	Invalid `schedule_time` format. Expected epoch milliseconds.
checkin_status_message_restricted	The `check_in` status trigger is not supported for this chat type (e.g. direct messages).
extra_key_found	An unsupported key was included in the request body.

Error Response Format

When an error occurs, the API returns a JSON response in this format:

{"message": "A human-readable description of the error.", "code": "error_code"}

where code is the error identifier (as listed above) and message is a human-readable explanation of what went wrong.

OAuth Scope : ZohoCliq.Messages.UPDATE

Arguments

text

string

Updated message text content to replace the existing text.
Maximum length: 5000 characters.

schedule_time

long

New scheduled delivery time for the message, in epoch milliseconds. Replaces the existing scheduled time.

schedule_timezone

string

Timezone to use for the updated scheduled time. Example: Asia/Kolkata.
Maximum length: 100 characters.

schedule_status

string

New status trigger for the message. When provided, switches the message from time-based to status-based scheduling.
Allowed values:

check_in: Delivers the message when the sender checks in.
check_out: Delivers the message when the sender checks out.
user_available: Delivers the message when the sender becomes available.
call_end: Delivers the message when the sender ends a call.

file_remove

boolean

Controls removal of an existing file attachment from the scheduled message.
Allowed values:

true: Removes the existing file attachment from the message. The message text and schedule remain unchanged.
false: Retains the existing file attachment. This is the default behavior.

Path Parameters

CHAT_ID

string

(Required)

Unique identifier of the chat or channel that contains the scheduled message to be edited.
To learn how to retrieve this ID, see CHAT_ID in the Glossary page.

SCHEDULED_MESSAGE_ID

string

(Required)

Unique identifier of the scheduled message to edit. Use this to target a specific pending message within the chat.
To retrieve this ID, use the List all scheduled messages endpoint.

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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID"
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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID")
  .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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID', 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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID", 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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_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();

var client = new RestClient("https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID");
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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID"),
    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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID"

	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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID");
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/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

Body Parameters

{
    "text": "Q2 Expense Report Deadline [UPDATED]: Submission extended to June 6. Ensure all vendor invoices above $500 have manager approval. Contact @financeTeam for help.",
    "schedule_time": 1748947800000,
    "schedule_timezone": "Asia/Kolkata"
}

{
    "schedule_status": "call_end"
}

{
    "file_remove": true
}

Response Example

{
    "url": "/api/v3/chats/CT_1424569695482328362_631836344/scheduledmessages/3574bbf2-77ed-4b9c-99d9-8d487d6f8d11",
    "type": "scheduledmessages",
    "data": {
        "id": "3574bbf2-77ed-4b9c-99d9-8d487d6f8d11",
        "timezone": "Asia/Kolkata",
        "created_time": "2026-05-29T03:15:49-07:00",
        "time": "2026-06-01T20:30:00-07:00",
        "message": {
            "sender": {
                "name": "Priya",
                "id": "697322516"
            },
            "type": "text",
            "content": {
                "text": "Q2 Expense Report Deadline [UPDATED]: Submission extended to June 6. Ensure all vendor invoices above $500 have manager approval. Contact @financeTeam for help."
            },
            "is_pinned": false
        },
        "creator": {
            "name": "Priya",
            "id": "697322516"
        }
    }
}

{
    "url": "/api/v3/chats/1424921584119739269/scheduledmessages/84fe7397-ab35-4aef-8bf7-944d688857af",
    "type": "scheduledmessages",
    "data": {
        "id": "84fe7397-ab35-4aef-8bf7-944d688857af",
        "timezone": "Asia/Kolkata",
        "created_time": "2026-05-29T04:27:40-07:00",
        "schedule_status": "call_end",
        "message": {
            "sender": {
                "name": "Priya",
                "id": "697322516"
            },
            "type": "text",
            "content": {
                "text": "Hi Benjamin, just a quick nudge. Please update the approval status for Claim #EXP-2026-0412 when you are available. No rush, respond whenever you are free!"
            },
            "is_pinned": false
        },
        "creator": {
            "name": "Priya",
            "id": "697322516"
        }
    }
}

{
    "url": "/api/v3/chats/CT_1424569695482328362_631836344/scheduledmessages/de8518c4-ce33-46c1-9195-d7864b9f10ce",
    "type": "scheduledmessages",
    "data": {
        "id": "de8518c4-ce33-46c1-9195-d7864b9f10ce",
        "timezone": "Asia/Kolkata",
        "created_time": "2026-05-29T04:31:33-07:00",
        "time": "2026-06-06T21:00:00-07:00",
        "message": {
            "sender": {
                "id": "697322516"
            },
            "type": "file",
            "content": {
                "file_name": "Expense Summary - Zylker.pdf",
                "file_size": "61.05 KB",
                "comment": "Please find the attached Q2 Expense Summary report. Review before the finance sync on June 6 and flag any discrepancies to @financeTeam."
            },
            "is_pinned": false
        },
        "creator": {
            "name": "Priya",
            "id": "697322516"
        }
    }
}

{
    "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": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

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

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

Delete a scheduled message 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

Deletes a specific scheduled message by its ID. Use this to remove a single pending message from a chat without affecting other scheduled messages in the same conversation.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

! Possible Error Codes Click to expand

Error Code	Description
scheduled_msg_not_found	The requested scheduled message could not be found.

Error Response Format

When an error occurs, the API returns a JSON response in this format:

{"message": "A human-readable description of the error.", "code": "error_code"}

where code is the error identifier (as listed above) and message is a human-readable explanation of what went wrong.

OAuth Scope : ZohoCliq.Messages.DELETE

Path Parameters

CHAT_ID

string

(Required)

Unique identifier of the chat or channel that contains the scheduled message to be deleted.
To learn how to retrieve this ID, see CHAT_ID in the Glossary page.

SCHEDULED_MESSAGE_ID

string

(Required)

Unique identifier of the scheduled message to delete. Use this to target the specific pending message to remove.
To retrieve this ID, use the List all scheduled messages endpoint.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID")
  .delete(null)
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

fetch('https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID', 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("DELETE", "/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID", headers=headers)

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

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

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_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();

var client = new RestClient("https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Delete,
    RequestUri = new Uri("https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_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);
}

package main

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

func main() {

	url := "https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID"

	req, _ := http.NewRequest("DELETE", 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("DELETE", "https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request DELETE \
  --url https://cliq.zoho.com/api/v3/chats/CHAT_ID/scheduledmessages/SCHEDULED_MESSAGE_ID \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "Response Code": "204 No response"
}

{
    "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": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

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

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

Scheduled Messages 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

List all scheduled messages 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

Send scheduled messages now 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

Path Parameters

Bulk reschedule scheduled messages 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

Path Parameters

List scheduled messages in a chat 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

Path Parameters

Query Parameters

Path Parameters

Edit a scheduled message 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

Path Parameters

Delete a scheduled message 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

Path Parameters

Scheduled Messages 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

List all scheduled messages 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

Send scheduled messages now 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

Edit a scheduled message 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

Delete a scheduled message 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