POST - Add group Task
Purpose
This API is used to add a new task to the specified group.
Request URL
https://mail.zoho.com/api/tasks/groups/<GroupID>
Request Parameters
| Parameter | Data Type | Description |
| GroupID* | Integer | The unique identifier used for groups in the organization |
* - Mandatory parameters
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 |
| dueDateRemindersEnabled | Boolean | for enabled state - true for disabled state - false | Whether reminders on the date when the task is due is enabled or disabled |
| 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 |
| remindOwner | Boolean | to remind owner - true to disable reminder for owner - false | If the task owner needs to reminded |
| remindAssignee | Boolean | to remind assignee - true to disable reminder for assignee - false | If the member to whom the task is assigned needs to be reminded |
| 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 | - | |
| followers | JSON Array | - | The members who need to follow this task |
| lockInvites | Boolean | to lock invite - true to unlock invite - false | If the permission to invite members has to be enabled or disabled |
| allowComments | Boolean | to allow comments - true to disallow comments - false | If comments for the task can be allowed or not |
| senderid | Email Address | sender name@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) | 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
https://mail.zoho.com/api/tasks/groups/53658048
Sample Input:
{
"title" : “Blog Updates”,
"description" : “Revamp update blog and announcements”,
"priority" : "high",
"reminderDate" : "2018-03-28T17:47:40+05:30",
"emailReminder" : "true",
"assignee" : "54161899",
"recurringType" : "Monthly",
"dueDate" : "29/08/2018",
"recurMonthlyOnDayOfMonth" : "1",
"recurringFrequency" : "2",
"followers" : ["54938724"],
"lockInvites" : "true",
"allowComments" : "false",
"projectId" : "48184000000005003",
"accountId" : "48019000000005001",
"messageId" : "48019000000032001"
} Sample Response
{
"status": {
"code": 200,
"description": "success"
},
"data": {
"owner": {
"name": "Rebecca",
"id": 54136518
},
"numberOfSubtasks": 0,
"modifiedTime": "2018-03-28T17:13:40+05:30",
"attachments": [],
"reminder": {
"dateTime": "2018-03-28T17:47:40+05:30",
"emailReminder": true,
"popupReminder": false
},
"subtasks": [],
"recurring": {
"recurMonthlyOnDayOfMonth": 1,
"type": "Monthly",
"frequency": 2
},
"dueDate": "29/08/2018",
"description": "Make the announcement ready for the recent revamp",
"project": {
"name": "Blogging",
"id": "48184000000005003"
},
"title": "Blog Updates",
"priority": "High",
"tags": [],
"createdAt": "2018-03-28T17:13:40+05:30",
"followers": [
{
"name": "Justin Case",
"id": 54224987,
"group": true
},
{
"name": "Marketing",
"id": 54938724
}
],
"namespaceId": "54224987",
"id": "48184000000093001",
"assignee": {
"name": "Paula M",
"id": 54161899
},
"status": "In Progress"
}
}