Create Label

This API helps in creating a label.

Endpoints

post https://www.zohoapis.com/workdrive/api/v1/labels

Copy full URL

OAuth Scope

WorkDrive.labels.CREATECopied!

curl --request POST \
  --url https://www.zohoapis.com/workdrive/api/v1/labels \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"color":"FBE983","user_id":"5nek5a28a8c9201f64a07b7196524264ed528-181767000000047009","name":"Product Design"},"type":"labels"}}'

header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("color","FBE983");
att_param1.put("user_id","5nek5a28a8c9201f64a07b7196524264ed528-181767000000047009");
att_param1.put("name","Product Design");
data_param1.put("attributes",att_param1);
data_param1.put("type","labels");
data.put("data",data_param1);
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/labels"
type : POST
parameters : data.toString()
headers : header
connection : "wdconnection"
];
info response;

Request Body

application/vnd.api+json

dataJSON Object(Required)

Hide Sub-Attributes

attributesJSON Object(Required)

Hide Sub-Attributes

colorstring(Required)

Color to represent the label. It refers to the 6-digit color code (you can use any color code; however, only limited colors are available in the web app user interface).

user_idstring(Required)

A unique ID of the team member that is created when a member is added in a team.

namestring(Required)

Name of the label

typestring(Required)

The JSON:API resource type. Always "labels".

Allowed Values :

Show Values ▾

  {
    "data": {
      "attributes": {
        "color": "FBE983",
        "user_id": "5nek5a28a8c9201f64a07b7196524264ed528-181767000000047009",
        "name": "Product Design"
      },
      "type": "labels"
    }
  }

▼ Show full

  {
    "data": {
      "id": "5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001",
      "type": "labels",
      "attributes": {
        "color": "FBE983",
        "name": "Product Design",
        "index": 4,
        "team_id": "5nek5a28a8c9201f64a07b7196524264ed528",
        "type": 1,
        "label_id": "181767000000449001"
      },
      "relationships": {
        "files": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001/relationships/files",
            "related": "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001/files"
          }
        }
      },
      "links": {
        "self": "https://www.zohoapis.com/workdrive/api/v1/labels/5nek5a28a8c9201f64a07b7196524264ed528-181767000000449001"
      }
    }
  }

  {
    "errors": [
      {
        "id": "L003",
        "title": "Label color should not be empty"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "L002",
        "title": "Label name should not exceed 25 characters"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "L001",
        "title": "Label name should not be empty"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "L005",
        "title": "Maximum label limit reached"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "L004",
        "title": "Label with this name already exists"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "L006",
        "title": "Failed to create label"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "F000",
        "title": "General Exception"
      }
    ]
  }

▼ Show full