Create data template API in Zoho WorkDrive

Data Templates and Custom Fields

In WorkDrive, you can create data templates and associate the required files and folders with them by adding custom information or properties. Once you associate files and folders to a data template with custom values, you can easily search for and manage data using the Data Templates filter. Learn more about Data Templates in WorkDrive

Custom Field Types

Custom Field Type	Value Format	Supported field_properties
text	string	description default_value max_char_length is_mandatory
multiline_text	string	description is_mandatory
number	all type of numeric value	description default_value min_value max_value is_mandatory
datetime	date time in milli second	description default_value is_mandatory
date	date in milli second	description default_value is_mandatory
yes_or_no	boolean	description default_value is_mandatory
dropdown	value in given choice list	description default_value is_mandatory
radio	value in given choice list	description default_value is_mandatory
checkbox	values in given choice list as JSON Array	description default_value is_mandatory
email	valid email address	description is_mandatory
multi_email	valid email address in JSON array format	description is_mandatory

Download Data Templates and Custom Fields OpenAPI Document

Download

Create Data Template

This API creates a new data template.

A new 'data_template_id' is created when you create a new data template.

Endpoints

post https://www.zohoapis.com/workdrive/api/v1/teams/{team_id}/datatemplates

Copy full URL

OAuth Scope

WorkDrive.datatemplates.CREATECopied!

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

header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("name","Recruitment - 2020");
att_param1.put("description","Associate files and folders of all candidates registered for recruitment in 2020");
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/teams/{team_id}/datatemplates"
type : POST
parameters : data.toString()
headers : header
connection : "wdconnection"
];
info response;

Path Parameters

team_idstring(Required)

A unique ID of the team in which the data template is created.

Request Body

application/vnd.api+json

dataJSON Object(Required)

Hide Sub-Attributes

attributesJSON Object(Required)

Hide Sub-Attributes

namestring(Required)

A name for the data template.

descriptionstring(Optional)

A description for the data template.

typestring(Required)

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

Allowed Values :

Show Values ▾

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

▼ Show full

  {
    "data": {
      "id": "nrkroc4c5f3259e2a410da17c3915ea990dde-24000000581001",
      "type": "datatemplates",
      "attributes": {
        "created_time_i18": "Sep 7, 6:40 PM",
        "name": "Recruitment - 2020",
        "modified_by": "15077877",
        "description": "Associate files and folders of all candidates registered for recruitment in 2020",
        "modified_by_user": "Anna Baker",
        "team_id": "nrkroc4c5f3259e2a410da17c3915ea990dde",
        "custom_fields_count": 0,
        "created_time_in_millisecond": 1631020235366,
        "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": "CF050",
        "title": "Empty or same dataTemplate Name is not allowed"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "CF052",
        "title": "Max template count reached"
      }
    ]
  }

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

▼ Show full