Save File as Template

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API saves any Zoho format file (i.e., Writer, Sheet, or Show) in WorkDrive as a template (to My Templates or Org Templates).

Endpoints

OAuth Scope

WorkDrive.libraries.CREATECopied!

Request Example

cURL
cURL
Deluge
Copied!
curl --request POST \
  --url https://www.zohoapis.com/workdrive/api/v1/files/{library_id}/saveastemplate \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"name":"Marketing Template","resource_id":"ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2"},"type":"files"}}'

Path Parameters

library_idstring(Required)

The template library ID of My Templates/Org Templates/Public Templates where the template is to be saved

Request Body

application/vnd.api+json
dataJSON Object(Required)
Hide Sub-Attributes
attributesJSON Object(Required)
Hide Sub-Attributes
namestring(Required)

Name of the newly saved template

resource_idstring(Required)

The resource ID of the Zoho format file, which is to be saved as a template

typestring(Required)

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

Allowed Values :
Show Values
filesCopied!
Copied!Copy all as JSON Array

Body Parameters

Copied!
  {
    "data": {
      "attributes": {
        "name": "Marketing Template",
        "resource_id": "ly9zm1d1ee3b833c1438a9232ad6ac77bc8f2"
      },
      "type": "files"
    }
  }
                
Show full

Response Example

R004

R004

R002

R023

F7003

R008

R008

F7004

F000

200
200
400
401
403
500
Copied!
  {
    "data": [
      {
        "id": "la6u1f12110c4f9a54bec9367c8ca5d91b89d",
        "type": "files",
        "attributes": {
          "modified_by_zuid": "940668",
          "is_locked": false,
          "conv_engine_type": 0,
          "is_fillable_resource": false,
          "is_published": false,
          "destination_id": "rabj0c77da12d4c1f4fe39d4c269919e57d4d",
          "storage_info": {
            "files_count": 0,
            "folders_count": 0,
            "size_in_bytes": 0,
            "storage_used_in_bytes": 0,
            "storage_used_by_workdrive_in_bytes": 0,
            "storage_used_by_app_in_bytes": 0
          },
          "type": "writer",
          "created_time_i18": "Nov 23, 12:22 PM",
          "modified_time_in_millisecond": 1637650331725,
          "opened_time": "Nov 23, 12:22 PM",
          "status_change_time": "Nov 23, 12:22 PM",
          "download_url": "https://downloadserver.zoho.com/v1/workdrive/download/la6u1f12110c4f9a54bec9367c8ca5d91b89d",
          "comment_badge_count": 0,
          "is_app_associated": false,
          "created_time": "Nov 23, 12:22 PM",
          "lock_status": 2,
          "is_folder": false,
          "resource_type": 2001,
          "is_email_in_upload": false,
          "display_attr_name": "Copy of My temp",
          "user_access_time": "Nov 23, 12:22 PM",
          "created_by": "jee j",
          "display_html_name": "Copy of My temp",
          "labels": [],
          "user_access_time_i18": "Nov 23, 12:22 PM",
          "org_id": "d73mf85e5258237e240408744f8181acd0809",
          "parent_id": "rabj0c77da12d4c1f4fe39d4c269919e57d4d",
          "name": "Copy of My temp",
          "status_change_time_in_millisecond": 1637650331725,
          "permalink": "https://writer.zoho.com/writer/open/la6u1f12110c4f9a54bec9367c8ca5d91b89d",
          "favorite": false,
          "new_badge_count": 0,
          "status": 1,
          "modified_time_i18": "Nov 23, 12:22 PM",
          "opened_time_i18": "Nov 23, 12:22 PM",
          "extn": "zwriter",
          "user_access_time_in_millis": 1637650331761,
          "shortcut_link": "",
          "status_change_time_i18": "Nov 23, 12:22 PM",
          "description": "",
          "uploaded_time_in_millisecond": 1637650331286,
          "thumbnail_url": "https://previewengine.zoho.com/thumbnail/WD/la6u1f12110c4f9a54bec9367c8ca5d91b89d",
          "title": "",
          "modified_time": "Nov 23, 12:22 PM",
          "library_id": "rabj0c77da12d4c1f4fe39d4c269919e57d4d",
          "icon_class": "writer",
          "created_time_in_millisecond": 1637650331286,
          "owner": "55101720",
          "creator": "940668",
          "capabilities": {
            "can_read": true,
            "can_share": false,
            "can_remove_share": false,
            "can_delete": true,
            "can_edit": true,
            "can_upload_files": true,
            "can_trash": true,
            "can_rename": true,
            "can_restore": false,
            "can_copy": true,
            "can_move": false,
            "can_zip": true,
            "can_download": true,
            "can_emailattach": true,
            "can_publish": true,
            "can_create_task": true,
            "can_share_support": true,
            "can_label": true,
            "can_delist_file": false,
            "can_associate_data_template": true,
            "can_favorite": true,
            "can_checkout": true,
            "can_cancel_checkout": false,
            "can_discard_checkout": false,
            "can_checkin": false,
            "can_read_comment": true,
            "can_create_comment": true,
            "can_trash_files": true
          },
          "uploaded_time_i18": "Nov 23, 12:22 PM",
          "is_external_upload": false,
          "watch_preference": {
            "watch": false,
            "notifyemail": false,
            "notifybell": false
          },
          "opened_time_in_millisecond": 1637650331761,
          "edit_badge_count": 0,
          "share_data": [],
          "data_template_id_to_mandate": "",
          "uploaded_time": "Nov 23, 12:22 PM",
          "has_folders": false,
          "service_type": "zw",
          "display_url_name": "Copy+of+My+temp",
          "is_unread": false,
          "modified_by": "jee j",
          "embed_props": {}
        },
        "relationships": {
          "folders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/folders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/folders"
            }
          },
          "unzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/unzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/unzip"
            }
          },
          "accesschartdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/accesschartdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/accesschartdata"
            }
          },
          "resourceproperty": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/resourceproperty",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/resourceproperty"
            }
          },
          "shortcut": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/shortcut",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/shortcut"
            }
          },
          "importfile": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/importfile",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/importfile"
            }
          },
          "permissions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/permissions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/permissions"
            }
          },
          "saveastemplate": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/saveastemplate",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/saveastemplate"
            }
          },
          "links": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/links",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/links"
            }
          },
          "copy": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/copy",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/copy"
            }
          },
          "previewzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/previewzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/previewzip"
            }
          },
          "tasks": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/tasks",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/tasks"
            }
          },
          "custommetadata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/custommetadata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/custommetadata"
            }
          },
          "comments": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/comments",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/comments"
            }
          },
          "previewinfo": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/previewinfo",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/previewinfo"
            }
          },
          "publiclink": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/publiclink",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/publiclink"
            }
          },
          "parentfolders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/parentfolders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/parentfolders"
            }
          },
          "versions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/versions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/versions"
            }
          },
          "supportshare": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/supportshare",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/supportshare"
            }
          },
          "timeline": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/timeline",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/timeline"
            }
          },
          "files": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/files",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/files"
            }
          },
          "accessdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/accessdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/accessdata"
            }
          },
          "breadcrumbs": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/breadcrumbs",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/breadcrumbs"
            }
          },
          "entity": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/entity",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/entity"
            }
          },
          "statistics": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/statistics",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/statistics"
            }
          },
          "appdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/relationships/appdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d/appdata"
            }
          }
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/api/v1/files/la6u1f12110c4f9a54bec9367c8ca5d91b89d"
        }
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R004",
        "title": "Invalid resourceId"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R002",
        "title": "category with same name exists"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R023",
        "title": "Invalid name passed"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F7003",
        "title": "Invalid OAuth token"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R008",
        "title": "Insufficient permissions"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F7004",
        "title": "Invalid OAuth scope"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F000",
        "title": "General exception"
      }
    ]
  }
                
Show full