The purpose of this API is to update a task in Zoho Connect.
Request URL: | https://connect.zoho.com/pulse/api/updateTask |
OAuth Scope: | zohopulse.tasks.UPDATE |
Request Method: | POST |
Mandatory Header: | Header name: Authorization Header Value: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52 |
Parameters
Name | Description | Required |
scopeID | Network in which the task to be updated is in. You can get this from the Network list API. | Required |
taskId | ID of the task. Can be taken from the response of add task json. Note: It is not the streamId. | Required |
title | Updated task title. Maximum characters allowed is 3000. | Required |
desc | Task description. Maximum characters allowed is 3000. | Optional |
priority | Update priority as either: None | Low | Medium | High | Required |
status | Update the task status by using these values: 0,1,2,3,4 {0-OPEN, 1-STARTED, 2-IN PROGRESS, 3-FOR REVIEW, 4-COMPLETED} | Optional |
assigneeId | User IDs of the task assigness. Multiple IDs should be separated by a comma. | Optional |
removeAssigneeId | User IDs of assignees to be removed. Multiple IDs should be separated by a comma. | Optional |
eyear | Due year for the task. ex) 2019 | Optioanal |
emonth | Due month for the task. ex) 08 | Optional |
edate | Due day for the task. ex) 21 | Optonal |
isClearDueDate | You can clear the due date if needed. Set this as true to clear the date and false if you want to keep it. | Optional |
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/updateTask?scopeID=929000000015001&taskId=929000000855663&title=Task+updated&eyear=2018&emonth=03&edate=19&priority=High
Sample Response
Copied{
"updateTask": {
"endDateLong": "1521503999000",
"comment": {
"id": "929000000855680",
"time": "1521527713420",
"formatedTime": "07:35 PM",
"isApproved": "true",
"commentType": "SET_TASK_PRIORITY",
"canLike": "false",
"canComment": "false",
"bot": {
"items": {
"*^$@_TASKPRIORITY_*^$@": "High",
"*^$@_USERNAME_*^$@_2060758": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
}
},
"img": "https://css.zohostatic.com/pulse/v_197/images/BotDefault.png",
"msg": "*^$@_USERNAME_*^$@_2060758 has set priority as *^$@_TASKPRIORITY_*^$@."
},
"userDetails": {
"zuid": "-1",
"id": "-1",
"name": "Connect Bot"
},
"content": [
{
"text": "Patricia Boyle has set priority as High."
}
]
},
"formattedDueDate": "19 Mar",
"result": "success",
"title": "Task updated"
}
}