Update a folder

PUT

/api/content/management/folders/{configId}/{folderId}

const url = 'https://example.com/api/content/management/folders/example/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Renamed Folder","defaultType":"Article","description":"example","slug":"renamed-folder","parent":"FLD_PARENT123","isArchived":false,"readPerm":["example"],"writePerm":["example"],"deletePerm":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/content/management/folders/example/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Renamed Folder", "defaultType": "Article", "description": "example", "slug": "renamed-folder", "parent": "FLD_PARENT123", "isArchived": false, "readPerm": [ "example" ], "writePerm": [ "example" ], "deletePerm": [ "example" ] }'

Updates an existing folder

Authorizations

bearerAuth

Parameters

Path Parameters

configId

required

Repository configuration ID

string

folderId

required

Folder ID

string

Request Body

application/json

object

name

Updated folder name

string

Example

Renamed Folder

defaultType

Default content type for items in this folder

string

Example

Article

description

Updated folder description

string

slug

Updated URL slug

string

Example

renamed-folder

parent

Parent folder ID (set to null to move to root)

string | null

Example

FLD_PARENT123

isArchived

Archive or unarchive the folder

boolean

Example

false

readPerm

Roles with read permission

Array<string>

writePerm

Roles with write permission

Array<string>

deletePerm

Roles with delete permission

Array<string>

Responses

200

Folder updated successfully

application/json

object

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"
  ]
}

400

Invalid request