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 configure the reminder to notify you one or two days before the due date.

OAuth Scope

Use the scope

ZohoMail.tasks.ALL (or) ZohoMail.tasks.UPDATE

to generate the Authtoken.

ALL - Full access to tasks.

UPDATE - Update the reminder based on due date.

Request URL

Method: PUT

Group Task:

https://mail.zoho.com/api/tasks/groups/{zgid}/{taskId}

or

Personal Task:

https://mail.zoho.com/api/tasks/me/{taskId}

Path Parameters

  • zgid* long
    • Specifies the unique identifier used for groups in an organization.
    • This parameter can be retrieved from the Get all groups API.
  • taskId* long

Request Body ( JSON Object)

  • reminderDueDate* integer
    • Specifies the number of days before the due date when you want to be reminded.
    • Allowed Value: Any positive number.
  • emailReminder* boolean
    • Specifies whether the reminders need to be sent via email.
    • Possible values :
      • true (enable reminder via email).
      • false (disable reminder via email).
  • popupReminder* boolean
    • Specifies whether reminder notifications need be sent.
    • Possible values :
      • true (enable reminder notification).
      • false (disable reminder notification).

 

* - Mandatory parameter

Note:

Either emailReminder or popupReminder should be set to true. Both can be true if the user wants, but at least one should be true for the reminder to be set.

Response Codes

Refer here for the response codes and their meaning.

Sample Request

CopiedGroup Task:

curl "https://mail.zoho.com/api/tasks/groups/5******048/48184******91002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
"reminderDueDate" : "1",
"emailReminder" : "false",
"popupReminder" : “true”
 }'

Personal Task:

curl "https://mail.zoho.com/api/tasks/me/4818******00091002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
"reminderDueDate" : "1",
"emailReminder" : "false",
"popupReminder" : “true”
 }'