> ## Documentation Index > Fetch the complete documentation index at: https://developers.wrike.com/llms.txt > Use this file to discover all available pages before exploring further. # Update Folder Update folder. Scopes: Default, wsReadWrite # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Wrike API", "version": "4.0" }, "servers": [ { "url": "https://www.wrike.com/api/v4" }, { "url": "https://app-eu.wrike.com/api/v4" }, { "url": "https://app-us2.wrike.com/api/v4" } ], "paths": { "/folders/{folderId}": { "put": { "tags": [ "Folders & Projects" ], "summary": "Update Folder", "description": "Update folder.\n\nScopes: Default, wsReadWrite", "operationId": "PUT:/folders/single", "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/FolderId" } }, { "name": "title", "in": "query", "description": "Title", "required": false, "schema": { "type": "string", "description": "Title" } }, { "name": "description", "in": "query", "description": "Folder description", "required": false, "schema": { "type": "string", "description": "Folder description" } }, { "name": "addParents", "in": "query", "description": "Parent folders from same account to add, cannot contain rootFolderId and recycleBinId", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "Parent folders from same account to add, cannot contain rootFolderId and recycleBinId", "items": { "$ref": "#/components/schemas/FolderId" } } } } }, { "name": "removeParents", "in": "query", "description": "Parent folders from same account to remove, cannot contain rootFolderId and recycleBinId", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "Parent folders from same account to remove, cannot contain rootFolderId and recycleBinId", "items": { "$ref": "#/components/schemas/FolderId" } } } } }, { "name": "addShareds", "in": "query", "description": "Share folder with specified users or invitations", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "Share folder with specified users or invitations", "items": { "$ref": "#/components/schemas/UserId" } } } } }, { "name": "removeShareds", "in": "query", "description": "Unshare folder from specified users or invitations", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "Unshare folder from specified users or invitations", "items": { "$ref": "#/components/schemas/UserId" } } } } }, { "name": "metadata", "in": "query", "description": "Metadata to be updated. Limit : `100`", "required": false, "content": { "application/json": { "schema": { "maxItems": 100, "type": "array", "description": "Metadata to be updated", "items": { "$ref": "#/components/schemas/Metadata" } } } } }, { "name": "restore", "in": "query", "description": "Restore folder from Recycled Bin", "required": false, "schema": { "type": "boolean", "description": "Restore folder from Recycled Bin" } }, { "name": "customFields", "in": "query", "description": "Custom fields to be updated or deleted (null value removes field). Limit : `100`", "required": false, "content": { "application/json": { "schema": { "maxItems": 100, "type": "array", "description": "Custom fields to be updated or deleted (null value removes field)", "items": { "$ref": "#/components/schemas/CustomField" } } } } }, { "name": "customColumns", "in": "query", "description": "List of custom fields associated with folder", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "List of custom fields associated with folder", "items": { "$ref": "#/components/schemas/CustomFieldId" } } } } }, { "name": "clearCustomColumns", "in": "query", "description": "Remove all custom fields associated with folder", "required": false, "schema": { "type": "boolean", "description": "Remove all custom fields associated with folder" } }, { "name": "project", "in": "query", "description": "Project settings (update project or convert folder to project). Use null value to convert project to folder", "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderProjectUpdateParam" } } } }, { "name": "addAccessRoles", "in": "query", "description": "Specifies users with Access Roles for folder", "required": false, "schema": { "$ref": "#/components/schemas/UserId" } }, { "name": "removeAccessRoles", "in": "query", "description": "Specifies users whose Access Roles should be removed", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "Specifies users whose Access Roles should be removed", "items": { "$ref": "#/components/schemas/UserId" } } } } }, { "name": "withInvitations", "in": "query", "description": "Include invitations in ownerIds & sharedIds list", "required": true, "schema": { "type": "boolean", "description": "Include invitations in ownerIds & sharedIds list" } }, { "name": "convertToCustomItemType", "in": "query", "description": "Custom Item Type id", "required": false, "schema": { "$ref": "#/components/schemas/EntityTypeId" } }, { "name": "plainTextCustomFields", "in": "query", "description": "Strip HTML tags from custom fields", "required": false, "schema": { "type": "boolean", "description": "Strip HTML tags from custom fields" } }, { "name": "fields", "in": "query", "description": "Json string array of optional fields to be included in the response model\n* `contractType` - Contract type", "required": false, "content": { "application/json": { "schema": { "type": "array", "description": "Json string array of optional fields to be included in the response model", "items": { "type": "string", "enum": [ "contractType" ] } } } } } ], "responses": { "2XX": { "description": "success response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } }, "kind": { "$ref": "#/components/schemas/ResponseKind" } } } } } }, "4XX": { "description": "client-side error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "5XX": { "description": "server-side error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "HTTP": [] } ] } } }, "components": { "schemas": { "ResponseKind": { "type": "string", "enum": [ "accounts", "users", "contacts", "assets", "eDiscoveryReport", "folders", "folderTree", "tasks", "taskIds", "timelogs", "timelogCategories", "timelogLockPeriods", "timetrackerTimers", "comments", "attachments", "url", "version", "dataExport", "dataExportSchema", "auditLog", "accessRoles", "stream", "changes", "posts", "mailSettings", "integrationInfo", "gmailIntegrationSettings", "workTypesForIntegrations", "ids", "backups", "domains", "dependencies", "workflows", "workschedules", "workscheduleExclusions", "workscheduleUserExclusions", "customfields", "customfieldIds", "customstatuses", "invitations", "notifications", "jobroles", "placeholders", "groups", "session", "dashboards", "widgets", "taskCreationSettings", "colors", "experiments", "topics", "topicComments", "webhooks", "reviews", "boards", "textSearch", "chatChannels", "chatMessages", "forms", "requestForms", "request", "report", "platformWidgets", "platformWidgetInstances", "spaces", "pdf", "customerSatisfaction", "asyncJob", "approvals", "highlights", "highlightsList", "highlightsSettings", "highlightsCard", "timesheet", "timesheetRow", "timesheetSubmissionRule", "mobileFeatures", "mobileSettings", "folderBlueprintTree", "taskBlueprintTree", "feedback", "timeline_snapshot", "contactIds", "bookings", "integrateThreshold", "hourlyRatesProvision", "hourlyRates", "projectTeamMembers", "contactsHistory", "tasksHistory", "foldersHistory", "activityDigest", "workItemTemplates", "workTemplates", "workItemMetadata", "workItem", "customItemTypes", "verificationCode", "views", "listView", "tableView", "userTypes", "reactions", "externalRequesters", "workscheduleCapacityOverrides", "userCapacityOverrides", "userCapacityExclusions", "rollups", "requestFormPrefill", "cascadingFieldSettings" ] }, "CustomFieldId": { "pattern": "^([A-Z0-9]){16}$", "type": "string" }, "Metadata": { "required": [ "key", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "Value should be less than 1000 symbols, compatible with JSON string. Use JSON 'null' in order to remove metadata entry" }, "key": { "type": "string", "description": "Key should be less than 50 symbols and match following regular expression ([A-Za-z0-9_-]+)" } }, "description": "Metadata entries are isolated on per-client (application) basis" }, "ErrorType": { "type": "string", "enum": [ "invalid_request", "invalid_parameter", "parameter_required", "not_authorized", "access_forbidden", "not_allowed", "resource_not_found", "method_not_found", "too_many_requests", "rate_limit_exceeded", "server_error" ] }, "EntityTypeId": { "pattern": "^([A-Z0-9]){16}$", "type": "string" }, "ErrorResponse": { "type": "object", "properties": { "errorDescription": { "type": "string" }, "error": { "$ref": "#/components/schemas/ErrorType" } } }, "FolderProjectUpdateParam": { "type": "object", "properties": { "ownersRemove": { "type": "array", "description": "List of userIds to be removed from owners", "items": { "$ref": "#/components/schemas/UserId" } }, "endDate": { "type": "string", "description": "Project end date (null value to remove)
Format: yyyy-MM-dd" }, "contractType": { "$ref": "#/components/schemas/ContractType" }, "customStatusId": { "type": "string", "description": "Project custom status ID. Use this parameter if status value is not one of specified above" }, "ownersAdd": { "type": "array", "description": "List of userIds to be added as owners", "items": { "$ref": "#/components/schemas/UserId" } }, "startDate": { "type": "string", "description": "Project start date (null value to remove)
Format: yyyy-MM-dd" }, "status": { "$ref": "#/components/schemas/ProjectStatus" }, "budget": { "type": "number", "description": "Budget" } } }, "FolderColor": { "type": "string", "description": "* `Indigo4`\n* `Gray3`\n* `Indigo2`\n* `Indigo3`\n* `Gray2`\n* `Gray1`\n* `Yellow1`\n* `Yellow2`\n* `Yellow3`\n* `Blue1`\n* `Yellow4`\n* `Blue2`\n* `Green4`\n* `Blue3`\n* `Green3`\n* `Blue4`\n* `Green2`\n* `Green1`\n* `Orange4`\n* `Orange3`\n* `Orange2`\n* `Orange1`\n* `Person`\n* `Purple1`\n* `Purple2`\n* `Purple3`\n* `Pink1`\n* `Red3`\n* `Pink2`\n* `Red4`\n* `Pink3`\n* `Red1`\n* `Pink4`\n* `Red2`\n* `Purple4`\n* `DarkBlue1`\n* `DarkBlue3`\n* `DarkBlue2`\n* `DarkBlue4`\n* `YellowGreen4`\n* `YellowGreen3`\n* `YellowGreen2`\n* `YellowGreen1`\n* `Turquoise3`\n* `Turquoise4`\n* `Turquoise1`\n* `Turquoise2`\n* `Indigo1`\n* `DarkCyan2`\n* `None`\n* `DarkCyan1`\n* `DarkCyan4`\n* `DarkCyan3`", "enum": [ "Indigo4", "Gray3", "Indigo2", "Indigo3", "Gray2", "Gray1", "Yellow1", "Yellow2", "Yellow3", "Blue1", "Yellow4", "Blue2", "Green4", "Blue3", "Green3", "Blue4", "Green2", "Green1", "Orange4", "Orange3", "Orange2", "Orange1", "Person", "Purple1", "Purple2", "Purple3", "Pink1", "Red3", "Pink2", "Red4", "Pink3", "Red1", "Pink4", "Red2", "Purple4", "DarkBlue1", "DarkBlue3", "DarkBlue2", "DarkBlue4", "YellowGreen4", "YellowGreen3", "YellowGreen2", "YellowGreen1", "Turquoise3", "Turquoise4", "Turquoise1", "Turquoise2", "Indigo1", "DarkCyan2", "None", "DarkCyan1", "DarkCyan4", "DarkCyan3" ] }, "FolderId": { "pattern": "^([a-zA-Z0-9-_:\\.=]){1,256}$", "type": "string" }, "Folder": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/FolderColor" }, "customItemTypeId": { "$ref": "#/components/schemas/EntityTypeId" }, "childIds": { "type": "array", "description": "Child folder IDs", "items": { "$ref": "#/components/schemas/FolderId" } }, "scope": { "$ref": "#/components/schemas/TreeScope" }, "project": { "$ref": "#/components/schemas/FolderProject" }, "id": { "$ref": "#/components/schemas/FolderId" }, "title": { "type": "string", "description": "Title" }, "space": { "type": "boolean", "description": "Is folder a space" } } }, "ProjectStatus": { "type": "string", "description": "* `Red`\n* `OnHold`\n* `Yellow`\n* `Completed`\n* `Custom`\n* `Cancelled`\n* `Green`", "enum": [ "Red", "OnHold", "Yellow", "Completed", "Custom", "Cancelled", "Green" ] }, "CustomStatusId": { "pattern": "^([A-Z0-9]){16}$", "type": "string" }, "TreeScope": { "type": "string", "description": "* `WsTask` - Task in account\n* `RbRoot` - Virtual Recycle Bin folder of account\n* `RbFolder` - Folder is in Recycle Bin (deleted folder)\n* `WsFolder` - Folder in account\n* `WsRoot` - Virtual root folder of account\n* `RbTask` - Task is in Recycle Bin (deleted task)", "enum": [ "WsTask", "RbRoot", "RbFolder", "WsFolder", "WsRoot", "RbTask" ] }, "ContractType": { "type": "string", "description": "* `Billable` - Billable\n* `NonBillable` - Non-Billable", "enum": [ "Billable", "NonBillable" ] }, "FolderProject": { "required": [ "ownerIds", "status" ], "type": "object", "properties": { "createdDate": { "type": "string", "description": "Project created date
Format: yyyy-MM-dd'T'HH:mm:ss'Z'" }, "ownerIds": { "type": "array", "description": "List of project owner IDs", "items": { "$ref": "#/components/schemas/UserId" } }, "endDate": { "type": "string", "description": "Project end date
Format: yyyy-MM-dd" }, "contractType": { "$ref": "#/components/schemas/ContractType" }, "customStatusId": { "$ref": "#/components/schemas/CustomStatusId" }, "authorId": { "$ref": "#/components/schemas/UserId" }, "startDate": { "type": "string", "description": "Project start date
Format: yyyy-MM-dd" }, "completedDate": { "type": "string", "description": "Project completed date
Format: yyyy-MM-dd'T'HH:mm:ss'Z'" }, "finance": { "$ref": "#/components/schemas/FolderProjectFinance" }, "status": { "$ref": "#/components/schemas/ProjectStatus" } } }, "FolderProjectFinance": { "type": "object", "properties": { "plannedCost": { "type": "number", "description": "Planned cost" }, "plannedFees": { "type": "number", "description": "Planned fees" }, "currency": { "type": "string", "description": "Currency" }, "actualFees": { "type": "number", "description": "Actual fees" }, "actualCost": { "type": "number", "description": "Actual cost" }, "budget": { "type": "number", "description": "Budget" } } }, "UserId": { "pattern": "^([A-Z0-9]){8}$", "type": "string" }, "CustomField": { "required": [ "id", "value" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CustomFieldId" }, "value": { "type": "string", "description": "Custom field value. 4000 characters max. Should be valid string according to JSON RFC 8259. In particular, following characters must be escaped: quotation mark, reverse solidus, and the control characters (U+0000 through U+001F). Any character may be escaped, but unnecessarily escaped character can be implicitly translated to it's unescaped version.
In addition to RFC 8259 requirements, it is not recommended to use any of control characters in CF value.
Wrike's API forbids using U+0000 in every place and U+0011 at the beginning of the CF value string.
The correct way for setting multiple values in the multiple select Custom fields is ?customFields=[{\"id\":\"CustomFieldId\",\"value\":\"[\\\"value1\\\",\\\"value2\\\"]\"}]
The correct way for setting values in the people Custom fields is ?customFields=[{\"id\":\"CustomFieldId\",\"value\":\"UserId1, UserId2\"}]
Note that if custom field values are passed to API as URI param of request, they must be URI encoded. Here are some examples:
\"%5c\" - reverse solidus (backslash)
\"%5c%22\" - quotation mark
\"Vi%5Cu1ec7t\" - unicode-escaped character in word \"Việt\"
" } } } }, "securitySchemes": { "HTTP": { "type": "http", "description": "Use OAuth 2.0 access token or permanent access token for authorization.", "scheme": "bearer", "bearerFormat": "JWT" } } } } ```