DELETE - Delete Custom Status of a Group/Personal Task

Purpose

This API is used to delete a custom status added to a group or personal tasks. 

Note:

Users can delete only the custom status created by them. The predefined statuses(inprogress and completed) cannot be deleted.

OAuth Scope

Use the scope

ZohoMail.tasks.ALL (or) ZohoMail.tasks.DELETE

to generate the Authtoken.

ALL - Full access to tasks.

DELETE - Delete the custom status of tasks.

Request URL

Method: DELETE

Group Task:

https://mail.zoho.com/api/tasks/groups/{zgid}/customStatus

Personal Task:

https://mail.zoho.com/api/tasks/me/customStatus

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.

Request Body ( JSON Object)

  • status* integer
    • Specifies the ID of the custom status to be deleted.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - Group Tasks

Copiedcurl "https://mail.zoho.com/api/tasks/groups/116005836/customStatus" \
-X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken **************" \
-d '{
 "status": 13
}'

Sample Response - Group Tasks

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "status": 13
  }
}

Sample Request - Personal Tasks

Copiedcurl "https://mail.zoho.com/api/tasks/me/customStatus" \
-X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken **************" \
-d '{
 "status": 12
}'

Sample Response - Personal Tasks

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "status": 12
  }
}