v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB

Folders & Projects

Update Folder

Update folder.

<b>Scopes:</b> Default, wsReadWrite

put/folders/{folderId}

Path parameters

folderIdstring required

Query parameters

titlestring

Title

Title

descriptionstring

Folder description

Folder description

Parent folders from same account to add, cannot contain rootFolderId and recycleBinId

Parent folders from same account to remove, cannot contain rootFolderId and recycleBinId

Share folder with specified users or invitations

Unshare folder from specified users or invitations

Metadata to be updated. Limit : 100

restoreboolean

Restore folder from Recycled Bin

Restore folder from Recycled Bin

Custom fields to be updated or deleted (null value removes field). Limit : 100

List of custom fields associated with folder

clearCustomColumnsboolean

Remove all custom fields associated with folder

Remove all custom fields associated with folder

Project settings (update project or convert folder to project). Use null value to convert project to folder

addAccessRolesstring

Specifies users with Access Roles for folder

Specifies users whose Access Roles should be removed

withInvitationsboolean required

Include invitations in ownerIds & sharedIds list

Include invitations in ownerIds & sharedIds list

convertToCustomItemTypestring

Custom Item Type id

plainTextCustomFieldsboolean

Strip HTML tags from custom fields

Strip HTML tags from custom fields

Json string array of optional fields to be included in the response model

contractType - Contract type

Response

success response

kind'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' | 'userAggregatedCapacity' | 'cascadingFieldSettings'