Pin Team Folder
With the Pin feature, you can quickly access important Team Folders from a long list. When a Team Folder is pinned, it will appear at the top of the Team Folder list.
Note:
If there are multiple pinned Team Folders, it will get sorted in alphabetical order.
This API pins a Team Folder at the top of the Team Folder list.
Endpoints
OAuth Scope
WorkDrive.teamfolders.UPDATECopied!
curl --request PATCH \
--url https://www.zohoapis.com/workdrive/api/v1/teamfolders/{teamfolder_id} \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/vnd.api+json' \
--data '{"data":{"attributes":{"is_pinned":true},"type":"teamfolders"}}'Path Parameters
teamfolder_idstring(Required)
The unique ID of a team folder.
Request Body
application/vnd.api+jsondataJSON Object(Required)
Hide Sub-Attributes
attributesJSON Object(Required)
Hide Sub-Attributes
is_pinnedboolean(Required)
Set as "true" to pin the team folder
typestring(Required)
The JSON:API resource type. Always "teamfolders".
Allowed Values :
Show Values ▾
teamfoldersCopied!
Copy all as JSON Array
{
"data": {
"attributes": {
"is_pinned": true
},
"type": "teamfolders"
}
}
{
"data": {
"id": "ly9zm0170fb40015f4e2297a144e2b68cfa68",
"type": "teamfolders",
"attributes": {
"is_app_owned": false,
"is_public_within_team": false,
"is_pinned": true,
"view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"groups_count": 0,
"created_time_in_milliseconds": 1618251055482,
"description": "Marketing related files",
"is_built_in": false,
"storage_info": {
"size": "90.0 KB",
"storage_used": "90.0 KB",
"files_count": 2,
"folders_count": 1,
"size_in_bytes": 92684,
"storage_used_in_bytes": 92684
},
"last_accessed_time_in_milliseconds": 1618253011931,
"is_current_user_admin": true,
"files_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"unread_count": 1,
"role_id": 1,
"shared_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"is_app_associated": false,
"last_accessed_time": "Apr 13, 12:13 AM",
"is_share_allowed": true,
"created_time": "Apr 12, 11:40 PM",
"collaborators_count": 2,
"capabilities": {
"can_read": true,
"can_share": true,
"can_delete": true,
"can_edit": true,
"can_manage": true,
"can_create_files": true,
"can_upload_files": true,
"can_trash_files": true,
"can_leave": true,
"can_add_members": true,
"can_join": false,
"can_download_files": true
},
"unread_view_pref": {
"sort_by": "last_modified",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"incomingfiles_view_pref": {
"sort_by": "shared_time",
"sort_order": "desc",
"filtered_by": "all",
"layout": "list"
},
"is_org_team_folder": false,
"display_attr_name": "Marketing Details 2021",
"is_partof": true,
"is_default": false,
"created_by": "Zylker Creation",
"display_html_name": "Marketing Details 2021",
"created_by_zuid": "747938014",
"display_url_name": "Marketing+Details+2021",
"parent_id": "ly9zmae16b43c258f458a9a57ac02c4f8d763",
"last_accessed_by": "Zylker Creation",
"is_unread": true,
"name": "Marketing Details 2021",
"status": 1
},
"relationships": {
"settings": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/settings",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/settings"
}
},
"folders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/folders",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/folders"
}
},
"incomingfiles": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfiles",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfiles"
}
},
"trashedfiles": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/trashedfiles",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/trashedfiles"
}
},
"mydrafts": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/mydrafts",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/mydrafts"
}
},
"deletedfiles": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/deletedfiles",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/deletedfiles"
}
},
"permissions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/permissions",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/permissions"
}
},
"files": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/files",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/files"
}
},
"timeline": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/timeline",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/timeline"
}
},
"links": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/links",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/links"
}
},
"incomingfolders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/incomingfolders",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/incomingfolders"
}
},
"copy": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/copy",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/copy"
}
},
"unreadfiles": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/unreadfiles",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/unreadfiles"
}
},
"entity": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/entity",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/entity"
}
},
"outgoingfiles": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/outgoingfiles",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/outgoingfiles"
}
},
"appdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/relationships/appdata",
"related": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68/appdata"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/teamfolders/ly9zm0170fb40015f4e2297a144e2b68cfa68"
}
}
}
{
"errors": [
{
"id": "R221",
"title": "Invalid inputs"
}
]
}
{
"errors": [
{
"id": "U001",
"title": "User not logged in. Please Log in"
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Unauthorized access"
}
]
}
{
"errors": [
{
"id": "U030",
"title": "Invalid operation."
}
]
}
{
"errors": [
{
"id": "R004",
"title": "Invalid resourceId passed. Please use a valid resourceId"
}
]
}
{
"errors": [
{
"id": "R213",
"title": "Invalid operation"
}
]
}
{
"errors": [
{
"id": "R003",
"title": "Workspace with same name exists in your team. Please use a different name"
}
]
}
{
"errors": [
{
"id": "I055",
"title": "Association not exist"
}
]
}
{
"errors": [
{
"id": "F000",
"title": "General Exception"
}
]
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.