POST - Add new personal Task
Purpose
This API is used to add a new personal task.
Request URL
https://mail.zoho.com/api/tasks/me
Request Body (JSON Object)
Parameter | Data Type | Allowed Values | Description |
Title* | String | - | The title for the task that is being added |
Description | String | - | The task description |
Status | String | inprogress (or) completed | The status of completion of the task |
Priority | String | high (or) medium (or) low | The priority to be given for the task |
projectId | Long | - | The unique identifer assigned to each project created for group tasks |
parentTaskId | Long | - | The unique identifier given for the parent task |
dueDate | Date | dd/mm/yyyy | The due date that you want to set for the task |
reminderDate | Date | dd/mm/yyyy | The date when you want to be reminded about the task |
emailReminder | Boolean | to enable reminder - true to disable reminder - false | If reminders need to be sent via email |
popupReminder | Boolean | to enable reminder - true to disable reminder - false | If reminder notifications need be sent |
Assignee* | Long | zuid of the user | The zuid of the member to whom the task is assigned |
subtask | JSON Object | - | The details of the subtask that has to be added as a task |
accountId | Long | - | |
messageId | Long | - | |
senderid | Email Address | sendername@domainname.com | |
Recurring type | String | Daily (or) Weekly (or) Monthly (or) Yearly | The recurrence pattern for the task |
recurringFrequency | Integer | - | The frequency at which the task has to recur |
recurFrom | Date | dd/mm/yyyy | The date from which recurrence has to start |
recurUntil | Date | dd/mm/yyyy | The date until which the task has to recur |
recurFor | Integer | - | The number of times the task has to recur |
recurDailyOnlyOnWeekdays | Boolean | true; false | If the task has to recur everyday in the weekdays |
recurWeeklyOn | Integer | 1-7 (1 denotes Sunday and 7 denotes Saturday) | The day of the week when the task has to recur every week |
recurMonthlyOnDayOfWeekInMonth | Integer | Any date of the month | The day of the week in a particular month when the task has to recur every month |
recurMonthlyOnDayOfMonth | Integer | Any date of the month | The day of the month when the task has to recur every month |
recurMonthlyOnDayOfWeek | Integer | Days of the week (Sunday, Monday, etc.) | The day of the week when the task has to recur every month |
recurYearlyOnDayOfWeekInMonth | Integer | Ex: 3 indicates the 3rd week of the month | The day of the week in a particular month when the task has to recur every year |
recurYearlyOnDayOfMonth | Integer | Any date of the month | The date of the month when the task has to recur every year |
recurYearlyOnDayOfWeek | Integer | Days of the week (Sunday, Monday, etc.) | The day of the week when the task has to recur every year |
recurYearlyOnMonth | Integer | 0-11 (0 - January, 1 - February, etc.) | The month when the task has to recur for that year |
attachStoreName | JSON Array | - | The StoreName for the uploaded attachment |
attachPath | JSON Array | - | The path specified for the uploaded attachment |
* - Mandatory parameters
Note:
Use this API to get the attachStoreName and attachPath parameter values.
The 'recurMonthlyOnDayOfWeekInMonth' and 'recurMonthlyOnDayOfWeek' parameters should be used together. The 'recurYearlyOnDayOfMonth' and the 'recurYearlyOnMonth' parameters should be used together. Similarly, the 'recurYearlyOnDayOfWeek' and the 'recurYearlyOnMonth' parameters should be used together.
Response Codes
Please refer Response Codes.
Sample Request
Sample URL:
https://mail.zoho.com/api/tasks/me?
Sample Input:
{
"title": “Blog Updates”,
"description": “Announcement blog for recent revamp“,
"priority":"low"
}
Sample Response
{
"status":
{
"code":200,"description":"success"
},
"data":
{
"owner":
{
"name":"Rebecca",
"id":4650081
},
"numberOfSubtasks":0,
"modifiedTime":"2017-07-07T01:20:39+05:30",
"attachments":[],
"subtasks":[],
"description":"Announcement about the recent updates",
"project":
{
"name":"Blogging",
"id":"7000000006001"
},
"title":"Blog Updates",
"priority":"low",
"tags":[],
"createdAt":"2017-07-07T01:20:39+05:30",
"followers":[],
"namespaceId":"4650081",
"id":"7000000089009",
"assignee":
{
"name":"Rebecca",
"id":4650081
},
"status":"In Progress"
}
}