Skip to content

Create a folder

POST
/api/content/management/folders/{configId}
curl --request POST \
--url https://example.com/api/content/management/folders/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "My New Folder", "defaultType": "Article", "description": "A folder for organizing articles", "slug": "my-new-folder", "parent": "FLD_PARENT123", "readPerm": [ "editors", "viewers" ], "writePerm": [ "editors" ], "deletePerm": [ "admin" ] }'

Creates a new folder for organizing content

configId
required

Repository configuration ID

string
Media typeapplication/json
object
name
required

Folder name

string
Example
My New Folder
defaultType

Default content type for items created in this folder

string
Example
Article
description

Folder description

string
Example
A folder for organizing articles
slug

Custom URL slug (auto-generated if not provided)

string
Example
my-new-folder
parent

Parent folder ID for nested folders

string | null
Example
FLD_PARENT123
readPerm

Roles with read permission

Array<string>
Example
[
"editors",
"viewers"
]
writePerm

Roles with write permission

Array<string>
Example
[
"editors"
]
deletePerm

Roles with delete permission

Array<string>
Example
[
"admin"
]

Folder created successfully

Media typeapplication/json
object
id
required

Folder ID

string
name
required

Folder name

string
type
required

Item type (always ‘Folder’)

string
Allowed values: Folder
defaultType

Default content type for items in this folder

string
description

Folder description

string
slug
required

URL-friendly slug

string
slugSearch

Normalized slug for searching

string
createdDate
required

Creation timestamp (epoch ms)

number
updatedDate
required

Last update timestamp (epoch ms)

number
isArchived
required

Whether folder is archived

boolean
currentVersion
required

Current version number

string
latestVersion
required

Latest version number

string
isLatestVersion
required

Whether this is the latest version

boolean
createdByUser
required
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
updatedByUser
required
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
parent

Parent folder ID

string | null
readPerm

Roles with read permission

Array<string>
writePerm

Roles with write permission

Array<string>
deletePerm

Roles with delete permission

Array<string>
Example
{
"id": "FLD_ABC123",
"name": "My Folder",
"type": "Folder",
"defaultType": "Article",
"slug": "my-folder",
"createdDate": 1704067200000,
"updatedDate": 1704153600000,
"isArchived": false,
"currentVersion": "0.1",
"latestVersion": "0.1",
"isLatestVersion": true,
"createdByUser": {
"userName": "user@example.com",
"displayName": "John Doe",
"email": "user@example.com"
},
"updatedByUser": {
"userName": "user@example.com",
"displayName": "John Doe",
"email": "user@example.com"
},
"parent": "FLD_PARENT123",
"readPerm": [
"admin",
"editors"
],
"writePerm": [
"admin",
"editors"
],
"deletePerm": [
"admin"
]
}

Invalid request