> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# UpdateFolderDetails

# Package: collectionManagement

# Namespace: CollectionFolderService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/folders/update-folder-details.md

## Permission Scopes:
Manage Data Collections: SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE

## Introduction

Updates a folder's details.

> **Note**: Details of the root folder can't be updated.

---

## REST API

### Schema

```
 Method: updateFolderDetails
 Description: Updates a folder's details.  > **Note**: Details of the root folder can't be updated.
 URL: https://www.wixapis.com/wix-data/v1/folders/{folderId}/details
 Method: PATCH
 Method parameters:
   param name: folderDetails | type: FolderDetails   
        - name: name | type: string | description: Folder name as it appears in the [CMS](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-collection-folders). 
        - name: description | type: string | description: Folder description. 
 Return type: UpdateFolderDetailsResponse
  - name: folder | type: Folder | description: Updated folder. 
     - name: id | type: string | description: Folder GUID. Automatically generated by Wix.  The GUID field is empty for the root folder. 
     - name: name | type: string | description: Folder's name as displayed in the [CMS](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-collection-folders).  `name` is empty for the root folder. 
     - name: description | type: string | description: Folder description. 
     - name: folders | type: array<Folder> | description: Folders nested in the current folder.  Only the root folder may contain other folders. 
     - name: collectionReferences | type: array<CollectionReference> | description: Collection references in the current folder. 
        - name: collectionName | type: string | description: Collection's name as displayed in the [CMS](https://support.wix.com/en/article/cms-formerly-content-manager-creating-a-collection). 
        - name: folderId | type: string | description: GUID of the folder that contains the collection reference.  Omitted if the collection reference is in the root folder. 

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: FOLDER_NOT_FOUND | Description: Couldn't find the folder.


```

### Examples

### Update folder details
```curl
curl -X PATCH https://wixapis.com/autocms/v1/folders/593c732f-d781-4457-b4a9-7ad73ddf4b1a/details  \
    -H 'Authorization: <AUTH>' \
    -H 'Content-Type: application/json' \
    -d '{
           "folderDetails":{
              "description":"Only best collections"
           }
        }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.collectionManagement.CollectionFolderService.updateFolderDetails(folderId, options)
 Description: Updates a folder's details.  > **Note**: Details of the root folder can't be updated.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  folderId
 Method parameters: 
   param name: folderId | type: string | description: Folder GUID. | required: true
   param name: options | type: UpdateFolderDetailsOptions  none 
        - name: folderDetails | type: FolderDetails | description: Folder details to update.  Details that aren't specified remain unchanged. 
           - name: name | type: string | description: Folder name as it appears in the [CMS](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-collection-folders). 
           - name: description | type: string | description: Folder description. 
 Return type: PROMISE<UpdateFolderDetailsResponse>
  - name: folder | type: Folder | description: Updated folder. 
     - name: _id | type: string | description: Folder GUID. Automatically generated by Wix.  The GUID field is empty for the root folder. 
     - name: name | type: string | description: Folder's name as displayed in the [CMS](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-collection-folders).  `name` is empty for the root folder. 
     - name: description | type: string | description: Folder description. 
     - name: folders | type: array<Folder> | description: Folders nested in the current folder.  Only the root folder may contain other folders. 
     - name: collectionReferences | type: array<CollectionReference> | description: Collection references in the current folder. 
        - name: collectionName | type: string | description: Collection's name as displayed in the [CMS](https://support.wix.com/en/article/cms-formerly-content-manager-creating-a-collection). 
        - name: folderId | type: string | description: GUID of the folder that contains the collection reference.  Omitted if the collection reference is in the root folder. 

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: FOLDER_NOT_FOUND | Description: Couldn't find the folder.


```

### Examples

### updateFolderDetails
```javascript
import { folders } from '@wix/autocms-folders-service';

async function updateFolderDetails(folderId,options) {
  const response = await folders.updateFolderDetails(folderId,options);
};
```

### updateFolderDetails (with elevated permissions)
```javascript
import { folders } from '@wix/autocms-folders-service';
import { auth } from '@wix/essentials';

async function myUpdateFolderDetailsMethod(folderId,options) {
  const elevatedUpdateFolderDetails = auth.elevate(folders.updateFolderDetails);
  const response = await elevatedUpdateFolderDetails(folderId,options);
}
```

### updateFolderDetails (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { folders } from '@wix/autocms-folders-service';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { folders },
  // Include the auth strategy and host as relevant
});


async function updateFolderDetails(folderId,options) {
  const response = await myWixClient.folders.updateFolderDetails(folderId,options);
};
```

---