PUT - Set or change Task reminder based on due date
Purpose
This API is used to set or replace a reminder for a task, based on the due date that has been set. For example, you can set the reminder such that it reminds you one or two days before the due date.
Request URL
Group Task:
https://mail.zoho.com/api/tasks/groups/<GroupID>/<entityId>
Personal Task:
https://mail.zoho.com/api/tasks/me/<entityId>
Request Parameters
| Parameter | Data Type | Description |
| GroupID* | Long | The unique identifier used for groups in the organization |
| entityId* | Long | The unique identifier assigned to each task |
* - Mandatory parameters
Request Body (JSON Object)
| Parameter | Data Type | Allowed Values | Description |
| reminderDueDate* | Integer | - | The number of days before the due date when you want to be reminded |
| emailReminder* | Boolean | true; false | Whether the reminder should be sent via email |
| popupReminder* | Boolean | true; false | Whether the reminder should be sent as a popup notification |
* - Mandatory parameters
Either the emailReminder parameter or the popupReminder parameter has to be given in this API request.
Response Codes
Please refer Response Codes.
Sample Request
CopiedSample URL:
Group Task:
https://mail.zoho.com/api/tasks/groups/<53658048>/<48184000000091002>?
Personal Task:
https://mail.zoho.com/api/tasks/me/<48184000000091002>?
Sample Request Body:
{
"reminderDueDate" : "1",
"isEmailReminder" : "false",
"isPopupReminder" : "true"
}