Change data template description API in Zoho WorkDrive

Change Data Template Description

This API helps in changing the description of a data template.

Endpoints

patch https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}

Copy full URL

OAuth Scope

WorkDrive.datatemplates.UPDATECopied!

curl --request PATCH \
  --url https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id} \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"description":"Associate files and folders of all candidates registered for recruitment in 2021"},"type":"datatemplates"}}'

header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("description","Associate files and folders of all candidates registered for recruitment in 2021");
data_param1.put("attributes",att_param1);
data_param1.put("type","datatemplates");
data.put("data",data_param1);
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/datatemplates/{data_template_id}"
type : PATCH
parameters : data.toString()
headers : header
connection : "wdconnection"
];
info response;

Path Parameters

data_template_idstring(Required)

A unique ID of the data template.

Request Body

application/vnd.api+json

dataJSON Object(Required)

Hide Sub-Attributes

attributesJSON Object(Required)

Hide Sub-Attributes

descriptionstring(Required)

A description for the data template.

typestring(Required)

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

Allowed Values :

Show Values ▾

  {
    "data": {
      "attributes": {
        "description": "Associate files and folders of all candidates registered for recruitment in 2021"
      },
      "type": "datatemplates"
    }
  }

▼ Show full

  {
    "data": {
      "id": "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001",
      "type": "datatemplates",
      "attributes": {
        "name": "Recruitment - 2021",
        "modified_by": "15077877",
        "description": "Associate files and folders of all candidates registered for recruitment in 2021",
        "modified_by_user": "Anna Baker",
        "team_id": "nrkroc4c5f3259e2a410da17c3915ea990dde",
        "custom_fields_count": 0,
        "created_time_in_millisecond": 0,
        "created_by": "15077877",
        "created_by_user": "Anna Baker",
        "status": true
      },
      "relationships": {
        "customfields": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/relationships/customfields",
            "related": "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001/customfields"
          }
        }
      },
      "links": {
        "self": "https://www.zohoapis.com/workdrive/api/v1/datatemplates/nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001"
      }
    }
  }

  {
    "errors": [
      {
        "id": "CF036",
        "title": "Duplicate dataTemplateName found"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "CF037",
        "title": "This template is not enabled"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "CF050",
        "title": "Empty or same dataTemplate Name is not allowed"
      }
    ]
  }

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

▼ Show full