Create a new folder in a project
Creates a folder in the creator or reviewer tree. The required permission depends on `visibility`, as it does for move and copy: `creator` needs `canCreateFolder`; `reviewer` needs `canCreateReviewerFolder`, which only the workspace and project admin tiers hold. A creator can publish into the reviewer tree but not create folders there directly, matching the fact that they hold no reviewer move or copy right. Reserved names (`Review`, `Public`, `Submission`) are rejected (`reservedFolderName`, 400), as are base paths inside a virtual folder (`protectedBasePath`, 400). A `basePath` that does not exist returns `basePathNotFound` (404).
Creates a folder in the creator or reviewer tree. The required permission depends on visibility, as it does for move and copy: creator needs canCreateFolder; reviewer needs canCreateReviewerFolder, which only the workspace and project admin tiers hold. A creator can publish into the reviewer tree but not create folders there directly, matching the fact that they hold no reviewer move or copy right. Reserved names (Review, Public, Submission) are rejected (reservedFolderName, 400), as are base paths inside a virtual folder (protectedBasePath, 400). A basePath that does not exist returns basePathNotFound (404).
OAuth 2.1 authorization code flow with PKCE (required of every client, public or confidential). Scopes are a ceiling on the credential, not a grant of access: a token also cannot exceed what the user who approved it may already do. A write scope does not imply its matching read — ask for both.
In: header
Scope: projects:write
Path Parameters
Unique ID of the project.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$uuidWhich tree to operate on — the creator tree or the reviewer tree.
Value in
- "creator"
- "reviewer"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/creator/create-folder" \ -H "Content-Type: application/json" \ -d '{ "name": "Renders" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ownerResourceId": "7d5ad1db-89f9-42df-868c-86a72347ae1c", "ownerResourceType": "project", "creatorId": "688ebf54-d343-4104-8711-82c2feac534a", "creator": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string", "displayName": "string", "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779", "color": "string", "awards": [ "staff" ], "accountType": "standard" }, "publisherId": "f1ba8124-cabe-46cd-b4f9-1189594ff7b3", "inheritanceId": "09c886ac-e6e5-4263-a494-a6e14f7e4f46", "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c", "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0", "color": "string", "name": "string", "slug": "string", "fileSystemPaths": [ "string" ], "basePath": "string", "visibility": "creator", "noFileSystem": false, "tags": [], "status": "active", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}