Create upload folder

createUploadFolder(input: CreateUploadFolderInput!): UploadFolderSetting!

Requires project.uploads.write.

Arguments

ArgumentTypeRequired
inputCreateUploadFolderInput!Yes

Input fields

input

CreateUploadFolderInput

FieldTypeRequiredDescription
projectReferenceStringNoProject UUID, slug or configured domain. Omission does not select the context project.
folderPathStringNoFolder path; a trailing slash is appended when absent.
pathStringNoAnother spelling of folderPath. Send one of the two.
visibilityUploadFolderVisibilityNoFolder visibility (default project); changes from inherited visibility require path admin access. Default: "project".

Response

Returns UploadFolderSetting!. Open the type for its fields and nested types.

FieldTypeDescription
pathString!Folder path with trailing slash.
visibilityUploadFolderVisibility!Applied folder visibility.
permissionUploadPathGrantPermissionThe caller's access to the folder as the uploads list reports it: read, write or admin. Null when the list does not show the folder to the caller.
createdAtString!Creation time of the folder. A folder that already existed keeps its time.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation CreateUploadFolder($input: CreateUploadFolderInput!) {
  createUploadFolder(input: $input) {
    createdAt
    path
    permission
    visibility
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}