Skip to main content

Update a folder

Updates folder name and/or parent folder

Path Parameters
folderId uuid REQUIRED
Header Parameters
organization-id uuid REQUIRED

ID of organization context this request belongs to.

Request Body REQUIRED
name string

Possible values: length ≤ 100

parentFolderId uuid
Responses
200

folder updated

Schema OPTIONAL
createdAt date-time OPTIONAL
createdBy string OPTIONAL
customProperties object OPTIONAL

Contains optional properties. Please note that custom properties may disappear without notice.

id uuid OPTIONAL
name string OPTIONAL
parentId uuid OPTIONAL
permissions object[] OPTIONAL
group string OPTIONAL

Possible values: [ACCESS, ACCESS_DEFINITION, BUNDLE, CONSUMER, CONTACT, FILE, FOLDER, INVITATION, ORGANIZATION, PLAN, PLATFORM_ADMIN, PRODUCT, TENANT, TEAM, TECHNICAL_USER, USER, USER_ROLES]

files object[] OPTIONAL
createdAt date-time OPTIONAL
createdBy string OPTIONAL
id uuid OPTIONAL
mimeType string OPTIONAL
name string OPTIONAL
parentId uuid OPTIONAL
permissions object[] OPTIONAL
group string OPTIONAL

Possible values: [ACCESS, ACCESS_DEFINITION, BUNDLE, CONSUMER, CONTACT, FILE, FOLDER, INVITATION, ORGANIZATION, PLAN, PLATFORM_ADMIN, PRODUCT, TENANT, TEAM, TECHNICAL_USER, USER, USER_ROLES]

size int64 OPTIONAL
updatedAt date-time OPTIONAL
updatedBy string OPTIONAL
active boolean OPTIONAL
nodeType string OPTIONAL

Possible values: [README, API, MISC, CUSTOM]

subfolders (circular)[] OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL