Create or update a folder

put

https://developers.bloomreach.io/management/folder/v1/{folder_path}

Create a new folder that doesn't yet exist. Or if the folder exists, update its information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

folder_path

string

required

Path of a folder. This is the absolute path to the folder, including the folder name

Body Params

Request examples

A Folder is a container item that can contain other folders or items

type

string

required

identifies the kind of folder: valid values are "folder" for SimpleFolder and "pageFolder" for Pagefolder

path

string

required

Folder path. An absolute path of this document in the content repository

displayName

string

Display name of the of the folder. Used in labels in the CMS UI.

locale

string

Folder locale.

restricted

boolean

Indicates whether this folder is restricted. Setting this to false clears any readUsers and writeUsers entries automatically

allowedDocumentTypes

array of strings

List of allowed document types. Authors using the CMS UI will only be allowed to create documents in this folder of the types provided in this list. The value ALL_DOCUMENTS will offer them the possibility of creating any type of document. If this property is empty, they won't be able to create any document at all. Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.

allowedDocumentTypes

allowedFolderTypes

array of strings

List of allowed folder types. Authors using the CMS UI will only be allowed to create folders of the types provided in this list. If a value matches a content type, authors will be able to create a folder that only allows them to create that kind of document. The value FOLDER allows them to create an unrestricted folder where they can create any kind of document. The value UNSCOPED_FOLDER also allows them to create unrestricted folders, but in these case non translated ones, which are usualy created out of the channel folders (e.g /content/documents/administration) if the content inside them is going to be used in multiple channels with different locales.

allowedFolderTypes

readUsers

array of strings

List of users with read access in this restricted folder

readUsers

writeUsers

array of strings

List of users with write access in this restricted folder

writeUsers

Headers

X-Resource-Version

string

Resource's version, as obtained when GETting the resource. The first time a resource is created, a empty value is expected (omit the header). Must be used in any subsequent update requests of this resource

Responses

403

Forbidden

200OK

201Created