PUT - Set or Change Recurring Task Options

Purpose

This API is used to customize settings in a recurring task or to modify existing details in a recurring task.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to tasks.

UPDATE - Update settings in a recurring task.

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)

  • recurringType* string
    • Specifies the recurrence pattern for the task.
    • Possible values :
      • Daily
      • Weekly
      • Monthly
      • Yearly
  • recurringFrequency* integer
    • Specifies the frequency at which the task has to recur.
    • Acceptable values: Any positive number.
  • recurFrom string
    • Specifies the date from which recurrence has to start.
    • Format: "DD/MM/YYYY" (e.g.: 23/01/2024).
  • recurUntil string
    • Specifies the date until which the task has to recur.
    • Format: "DD/MM/YYYY" (e.g.: 23/01/2024).
  • recurFor integer
    • Specifies the number of times the task has to recur.
    • Acceptable values: Any positive number.
  • recurDailyOnlyOnWeekdays boolean
    • Specifies whether the task has to recur every day on the weekdays.
    • Possible values :
      • true 
      • false 
  • recurWeeklyOn integer
    • Specifies the day of the week when the task has to recur every week.
    • Possible values : (1 - 7), where 1 denotes Sunday and 7 denotes Saturday.
  • recurMonthlyOnDayOfWeekInMonth integer
    • Specifies the week number in a particular month when the task has to recur every month.
    • Possible values : (1 - 4). For example: 3 denotes 3rd week of the month.
  • recurMonthlyOnDayOfMonth integer
    • Specifies the day of the month when the task has to recur every month.
    • Possible values : Any date of the month.
  • recurMonthlyOnDayOfWeek integer
    • Specifies the day of the week when the task has to recur every month.
    • Possible values : (1 - 7), where 1 denotes Sunday and 7 denotes Saturday.
  • recurYearlyOnDayOfWeekInMonth integer
    • Specifies the week number in a particular month when the task has to recur every year
    • Possible values : (1 - 4). For example: 3 denotes 3rd week of the month.
  • recurYearlyOnDayOfMonth integer
    • Specifies the date of the month when the task has to recur every year.
    • Possible values : Any date of the month.
  • recurYearlyOnDayOfWeek integer
    • Specifies the day of the week when the task has to recur every year.
    • Possible values : (1 -7), where 1 denotes Sunday - 7 denotes Saturday.
  • recurYearlyOnMonth integer
    • Specifies the month when the task has to recur for that year.
    • Possible values : (0 - 11), where 0 denotes January and 11 denotes December.

 

* - Mandatory parameter

Note:

  • The recurMonthlyOnDayOfWeekInMonth and recurMonthlyOnDayOfWeek parameters should be used together. 
  • Similarly, the recurYearlyOnDayOfMonth and the recurYearlyOnMonth parameters should be used together. 
  • Similarly, the recurYearlyOnDayOfWeek and the recurYearlyOnMonth parameters should be used together.

Response Codes

Refer here for the response codes and their meaning.

Sample Request

CopiedGroup Task:

curl "https://mail.zoho.com/api/tasks/groups/5365*****/4818******00091002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \
-d '{
  "recurringType" : "Daily",
  "recurDailyOnlyOnWeekdays" : "1",
  "recurringFrequency"  : "2"
}'

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 '{
  "recurringType" : "Daily",
  "recurDailyOnlyOnWeekdays" : "1",
  "recurringFrequency"  : "2"
}'

Sample Response

Copied{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": {
        "recurring": {
            "recurDailyOnlyOnWeekdays": false,
            "type": "Daily",
            "frequency": 2
        },
    }
}