PUT - Change Task Status

Purpose

This API is used to change the status of a specific task.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to tasks.

UPDATE - Update a particular task's status.

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)

  • status* string
    • Provide the new status you wish to assign to the task.
    • Possible values:
      • inprogress
      • completed 

 

* - Mandatory parameter

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 '{
 "status": "completed"
 }'

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 '{
 "status": "completed"
 }'