Folders

Create a folder { name, workspace, parentFolder? }

POSThttps://backend.immut.io/api/v1/folders

Required scope: folders:write

Creating a duplicate under the same parent returns an "already exists" error. Re-list with parentFolder=all to get the existing id. Upload documents into a folder with POST /documents field folder=<id>.

Request body

Content type: application/json (required)

Field	Type	Required	Description
`name`	string	yes	folder name (required)
`workspace`	string	yes	workspace id (required)
`parentFolder`	string	no	parent folder id (optional). Omit for a top-level folder.

Responses

Status	Meaning
`200`	Success
`400`	BadRequest
`401`	Unauthorized
`403`	Forbidden
`429`	RateLimited

Example

curl -X POST "https://backend.immut.io/api/v1/folders" \
  -H "Authorization: Bearer $IMMUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>","workspace":"<workspace>","parentFolder":"<parentFolder>"}'

Generated from the immut API contract, version 1.9.0. Machine-readable: this page as markdown · everything in one file · OpenAPI