NFnforgeio
folders

Update folder.

If nested folders are enabled then it optionally expects a new parent folder UID that moves the folder and includes it into the response.

put/folders/{folder_uid}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/folders/{folder_uid}
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

folder_uidstring required

Request body

descriptionstring

NewDescription it's an optional parameter used for overriding the existing folder description

overwriteboolean

Overwrite only used by the legacy folder implementation

titlestring

NewTitle it's an optional parameter used for overriding the existing folder title

uidstring

NewUID it's an optional parameter used for overriding the existing folder UID

versioninteger

Version only used by the legacy folder implementation

Response

(empty)

accessControlMetadata

Metadata contains user accesses for a given resource Ex: map[string]bool{"create":true, "delete": true}

canAdminboolean
canDeleteboolean
canEditboolean
canSaveboolean
createdstring date-time
createdBystring
hasAclboolean
idinteger
parentUidstring

only used if nested folders are enabled

titlestring
uidstring
updatedstring date-time
updatedBystring
urlstring
versioninteger

Changes

No recorded changes to this operation across all 2 revisions of this API.