PUT - Edit Custom Status of a Group/Personal Task

Purpose

This API is used to edit a custom status of a group or personal tasks.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to tasks.

UPDATE - Update the custom status of tasks.

Request URL

Method: PUT

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)

  • statusName* string
    • Specifies the status name to be updated.
  • statusColour string
    • Specifies the color to represent the custom status.
    • The value must be provided in a hexadecimal color code format.
  • status integer
    • Specifies the unique identifier of the custom status to be updated.

 

* - 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/78762952/customStatus" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken **************" \
-d '{
 "statusName": “statustest”,
 "statusColour": “#2E8BD2“,
 "status":13
}'

Sample Response - Group Tasks

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "statusColour": "#2E8BD2",
    "statusName": "statustest",
    "status": 13
  }
}

Sample Request - Personal Tasks

Copiedcurl "https://mail.zoho.com/api/tasks/me/customStatus" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken **************" \
-d '{
 "statusName": “Under Testing”,
 "statusColour": “#2E8BD3“,
 "status":12
}'

Sample Response - Personal Tasks

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "statusColour": "#2E8BD3",
    "statusName": "Under Testing",
    "status": 12
  }
}