v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB

Folders & Projects

Create Folder

Create a folder within a folder. Specify virtual rootFolderId in order to create a folder in the account root.

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

post/folders/{folderId}/folders

Path parameters

folderIdstring required

Query parameters

titlestring required

Title, cannot be empty

Title, cannot be empty

descriptionstring

Folder description. If not specified, will be left blank

Folder description. If not specified, will be left blank

Users or invited users to share folder with. Folder is always shared with creator

Metadata to be added to newly created folder. Limit : 100

List of custom fields to be set upon task creation. Limit : 100

List of custom fields associated with folder

Project settings in order to create project

userAccessRolesstring

Access Roles assigned to users with which folder will be shared

withInvitationsboolean

Include invitations in ownerIds & sharedIds list

Include invitations in ownerIds & sharedIds list

customItemTypeIdstring

Custom Item Type ID to create a project from

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

customItemTypeId - Custom Item Type ID
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'