Task Reminder

Task Reminder

A task reminder allows you to set notifications for tasks that need your attention. Reminders help you stay organized by alerting you about due or upcoming tasks.

Attribute

task_id
string
Unique identifier of a task.
owners
array
Show Sub-Attributes arrow
user_id
string
Unique identifier of the user
user_name
string
Name of the user
user_email
string
Email address of the user
user_photo_url
string
Profile photo URL of the user
title
string
Title of the task
due_date
date
Due date of the task
due_date_formatted
string
Formatted due date
is_overdue
boolean
Indicates if the task is overdue
contact
object
Details of the related contact associated with a task
Show Sub-Attributes arrow
contact_id
string
Unique identifier of a contact
contact_name
string
Name of the contact
contact_type
string
Type of the contact which can be customer or vendor
parent_task
object
Show Sub-Attributes arrow
task_id
string
Parent task ID
task_name
string
Name of the parent task
task_number
string
Task number of the parent task
status
string
Parent task status
status_formatted
string
Formatted parent task status
status
string
Current status of the task
status_formatted
string
Formatted status of the task
color_code
string
Color associated with the task’s status
custom_status_id
string
Unique identifier of the custom status
billing_type
string
Type of billing applied to the task.
is_billable
boolean
Indicates whether the task is billable.
completion_percentage
number
Task completion percentage (0–100).
is_subtask
boolean
Indicates if this task is a subtask
priority
string
Priority level of the task
priority_formatted
string
Formatted priority level of the task
reminder
object
Details about the task reminder configuration
Show Sub-Attributes arrow
remind_before
number
Number of days, months or years before the task due date to send a reminder.
remind_at
date
Date when the reminder will be sent
remind_at_formatted
string
Formatted display value of the reminder date
remind_type
string
Type of reminder which can be days, months or years.
remind_type_formatted
string
Formatted value of the reminder type
alert_type
string
Type of alert for the reminder.
alert_type_formatted
string
Formatted type of alert for the reminder.
description
string
Detailed description of the task
is_accountant_task
boolean
Indicates if the task is an accountant task
task_number
string
Unique number assigned to the task.
task_number_prefix
string
Prefix used in the task numbering
task_number_suffix
number
Numeric suffix used in the task numbering
task_rate
number
Hourly or fixed rate applicable to the task.
can_push
boolean
Indicates if the task can be synced to client
created_by
object
Details of the user who created the task
Show Sub-Attributes arrow
user_id
string
Unique identifier of the user who created the task
user_name
string
Name of the user who created the task
last_modified_by
object
Details of the user who last modified the task
Show Sub-Attributes arrow
user_id
string
Unique identifier of the user who last modified the task
template_id
string
Unique identifier of the task template
due_after
number
Number of days after a certain date when the task is due

Example

{ "task_id": "982000000567001", "owners": [ { "user_id": "982000000321987", "user_name": "Jane Smith", "user_email": "jane.smith@example.com", "user_photo_url": "https://example.com/photos/jane_smith.jpg" } ], "title": "Prepare monthly financial report", "due_date": "2025-11-05", "due_date_formatted": "05/11/2025", "is_overdue": false, "contact": { "contact_id": "string", "contact_name": "string", "contact_type": "string" }, "parent_task": { "task_id": "982000000555001", "task_name": "Annual Audit", "task_number": "TASK-001", "status": "completed", "status_formatted": "Completed" }, "related_entity": { "entity_id": "982000000765321", "entity_type": "invoice", "entity": "20", "entity_value": "INV-001" }, "status": "completed", "status_formatted": "Completed", "color_code": "#FF5733", "custom_status_id": "982000000987654", "billing_type": "hourly", "is_billable": true, "completion_percentage": 75, "is_subtask": false, "priority": "high", "priority_formatted": "High", "reminder": { "remind_before": 2, "remind_at": "2025-11-13", "remind_at_formatted": "13/11/2025", "remind_type": "days", "remind_type_formatted": "Days", "alert_type": "email", "alert_type_formatted": "Email" }, "description": "Prepare and review the quarterly tax statements for ABC Corp.", "is_accountant_task": false, "task_number": "T-12345", "task_number_prefix": "TASK", "task_number_suffix": 2034, "task_rate": 1500, "can_push": true, "created_by": { "user_id": "982000000112233", "user_name": "John Doe" }, "last_modified_by": { "user_id": "982000000998877" }, "template_id": "982000000778899", "due_after": 10 }

Get tasks list

Get a list of tasks
OAuth Scope : ZohoBooks.settings.READ

Query Parameters

organization-id
string
(Required)
entity_id
string
Search tasks based on unique identifier of the entity linked to the task
sub_entity_id
string
Search tasks based on unique identifier of the sub-entity linked to the task
sort_column
string
Specify the column by which the results should be sorted
owner_id
string
Search tasks based on unique identifier of the owner of the task
contact_id
string
Search tasks based on unique identifier of the contact associated with the task
status
string
Filter tasks based on their current status. Allowed values are open, open and open
parent_status
string
Filter tasks based on the status of their parent task. Allowed values are open, open and open
parent_status_equal
string
Include only tasks whose parent task status is exactly equal to the given value. Allowed values are open, open and open
parent_status_not_equal
string
Exclude tasks whose parent task status is equal to the given value. Allowed values are open, open and open
search_text
string
Search tasks based on a search text
priority
string
Filter tasks by their priority level. Allowed values are low, lowest, high, highest and normal
filter_by
string
Filter tasks based on status of the task. Allowed values are All, Overdue, InProgress, Completed, YetToStarted, MyPending, DueToday, PriorityOverdue and Unassigned
entity_type
string
Search tasks based on the type of entity linked to the task
title
string
Search tasks with a title exactly matching the specified value
title_starts_with
string
Search tasks where the title starts with the specified text
title_contains
string
Search tasks where the title contains the specified text
description
string
Search tasks with a description exactly matching the specified value
description_starts_with
string
Search tasks where the description starts with the specified text
description_contains
string
Search tasks where the description contains the specified text
is_overdue
boolean
Filter tasks that are overdue based on their due date
created_by
string
Search tasks created by the given user identifier
is_accountant_task
string
Filter tasks that are accountant tasks
contact_ids
string
Search tasks linked to any of the specified contact IDs
owner_ids
string
Search tasks owned by any of the specified user IDs
date_start
string
Filter tasks with a start date on or after the specified date
date_end
string
Filter tasks with a due date on or before the specified date
task_number
string
Search tasks with an exact match for the task number
task_number_starts_with
string
Search tasks where the task number starts with the specified text
task_number_contains
string
Search tasks where the task number contains the specified text

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/tasks?organization-id=10234695" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v4/tasks?organization-id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/books/v4/tasks?organization-id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/books/v4/tasks?organization-id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/books/v4/tasks?organization-id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 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();
curl --request GET \ --url 'https://www.zohoapis.com/books/v4/tasks?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "tasks": [ { "task_id": "982000000567001", "task_number": "T-12345", "contact": { "contact_id": "string", "contact_name": "string", "contact_type": "string" }, "billing_type": "hourly", "is_billable": true, "task_rate": 1500, "completion_percentage": 75, "title": "Prepare monthly financial report", "created_time": "2025-10-28T08:30:00+05:30", "created_time_formatted": "Oct 28, 2025 08:30 AM", "due_date": "2025-11-05", "due_date_formatted": "05/11/2025", "is_accountant_task": false, "is_overdue": false, "parent_task": { "task_id": "982000000555001", "task_name": "Annual Audit", "task_number": "TASK-001", "status": "completed", "status_formatted": "Completed" }, "priority": "high", "priority_formatted": "High", "status": "completed", "status_formatted": "Completed", "color_code": "#FF5733", "description": "Prepare and review the quarterly tax statements for ABC Corp.", "subtask_count": 3, "is_subtask": false, "owners": [ { "user_id": "982000000321987", "user_name": "Jane Smith", "user_email": "jane.smith@example.com", "user_photo_url": "https://example.com/photos/jane_smith.jpg" } ] }, {...}, {...} ] }

Bulk delete tasks

Delete multiple tasks.
OAuth Scope : ZohoBooks.settings.DELETE

Query Parameters

organization-id
string
(Required)
task_ids
string
Unique identifiers of tasks, separated by commas

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/tasks?organization-id=10234695" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v4/tasks?organization-id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/books/v4/tasks?organization-id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/books/v4/tasks?organization-id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/books/v4/tasks?organization-id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 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();
curl --request DELETE \ --url 'https://www.zohoapis.com/books/v4/tasks?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Task deleted" }

Get task details

Get the details of a task.
OAuth Scope : ZohoBooks.settings.READ

Path Parameters

task_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/books/v4/tasks/982000000567001?organization-id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/books/v4/tasks/982000000567001?organization-id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 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();
curl --request GET \ --url 'https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "task": { "task_id": "982000000567001", "owners": [ { "user_id": "982000000321987", "user_name": "Jane Smith", "user_email": "jane.smith@example.com", "user_photo_url": "https://example.com/photos/jane_smith.jpg" } ], "title": "Prepare monthly financial report", "due_date": "2025-11-05", "due_date_formatted": "05/11/2025", "is_overdue": false, "contact": { "contact_id": "string", "contact_name": "string", "contact_type": "string" }, "parent_task": { "task_id": "982000000555001", "task_name": "Annual Audit", "task_number": "TASK-001", "status": "completed", "status_formatted": "Completed" }, "related_entity": { "entity_id": "982000000765321", "entity_type": "invoice", "entity": "20", "entity_value": "INV-001" }, "status": "completed", "status_formatted": "Completed", "color_code": "#FF5733", "custom_status_id": "982000000987654", "billing_type": "hourly", "is_billable": true, "completion_percentage": 75, "is_subtask": false, "priority": "high", "priority_formatted": "High", "reminder": { "remind_before": 2, "remind_at": "2025-11-13", "remind_at_formatted": "13/11/2025", "remind_type": "days", "remind_type_formatted": "Days", "alert_type": "email", "alert_type_formatted": "Email" }, "description": "Prepare and review the quarterly tax statements for ABC Corp.", "is_accountant_task": false, "task_number": "T-12345", "task_number_prefix": "TASK", "task_number_suffix": 2034, "task_rate": 1500, "can_push": true, "created_by": { "user_id": "982000000112233", "user_name": "John Doe" }, "last_modified_by": { "user_id": "982000000998877" }, "template_id": "982000000778899", "due_after": 10, "documents": [ { "document_id": "982000000567001", "is_custom_field_document": false, "comment": { "comment_id": "982000000567001" }, "document_name": "invoice_attachment.pdf", "document_type": "pdf", "document_size": 1048576, "document_size_formatted": "1 MB", "can_send_in_mail": true, "can_show_in_portal": true, "attachment_order": 1, "alter_text": "Scanned invoice copy", "source": "desktop", "source_formatted": "Desktop", "uploaded_on": "2025-10-28T09:00:00Z", "uploaded_on_formatted": "28/10/2025, 09:00 AM", "uploaded_by": { "user_id": "982000000567003", "user_name": "Jane Doe" } } ] } }

Delete a task

Delete a task.
OAuth Scope : ZohoBooks.settings.DELETE

Path Parameters

task_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/books/v4/tasks/982000000567001?organization-id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/books/v4/tasks/982000000567001?organization-id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 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();
curl --request DELETE \ --url 'https://www.zohoapis.com/books/v4/tasks/982000000567001?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Task deleted" }

Get task comments list

Get the list of comments of a task.
OAuth Scope : ZohoBooks.settings.READ

Path Parameters

task_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/tasks/982000000567001/comments?organization-id=10234695" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v4/tasks/982000000567001/comments?organization-id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/books/v4/tasks/982000000567001/comments?organization-id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/books/v4/tasks/982000000567001/comments?organization-id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/books/v4/tasks/982000000567001/comments?organization-id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 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();
curl --request GET \ --url 'https://www.zohoapis.com/books/v4/tasks/982000000567001/comments?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "comments": [ { "comment_id": "982000000567001", "description": "Please review the attached document.", "commented_by": { "user_id": "982000000321987", "user_name": "Jane Smith", "user_photo_url": "https://example.com/photos/jane_smith.jpg" }, "comment_type": "user", "can_delete": true, "date": "2025-10-28", "date_formatted": "28/10/2025", "date_description": "Today", "time": "09:15 AM", "operation_type": "Added", "transaction_id": "982000000567003", "transaction_type": "task_reminder" }, {...}, {...} ] }

Delete a task comment

Delete a comment of a task.
OAuth Scope : ZohoBooks.settings.DELETE

Path Parameters

task_id
string
(Required)
comment_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/tasks/982000000567001/comments/987000000654321?organization-id=10234695" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v4/tasks/982000000567001/comments/987000000654321?organization-id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/books/v4/tasks/982000000567001/comments/987000000654321?organization-id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/books/v4/tasks/982000000567001/comments/987000000654321?organization-id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/books/v4/tasks/982000000567001/comments/987000000654321?organization-id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 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();
curl --request DELETE \ --url 'https://www.zohoapis.com/books/v4/tasks/982000000567001/comments/987000000654321?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Comments deleted" }

Delete task document

Delete a document attached to a task.
OAuth Scope : ZohoBooks.settings.DELETE

Path Parameters

task_id
string
(Required)
document_id
string
(Required)

Query Parameters

organization-id
string
(Required)

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v4/tasks/982000000567001/documents/987000000654321?organization-id=10234695" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v4/tasks/982000000567001/documents/987000000654321?organization-id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/books/v4/tasks/982000000567001/documents/987000000654321?organization-id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/books/v4/tasks/982000000567001/documents/987000000654321?organization-id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/books/v4/tasks/982000000567001/documents/987000000654321?organization-id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 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();
curl --request DELETE \ --url 'https://www.zohoapis.com/books/v4/tasks/982000000567001/documents/987000000654321?organization-id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Attachment deleted" }