Update a folder

PUT

/collections/:collectionId/folders/:folderId

PUT

/collections/:collectionId/folders/:folderId

$ curl -X PUT https://api.getpostman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/folders/65a99e60-8e0a-4b6e-b79c-7d8264cc5caa \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Test Folder",
>   "description": "This is a test collection folder."
> }'

1 {
2   "data": {
3     "id": "65a99e60-8e0a-4b6e-b79c-7d8264cc5caa",
4     "name": "Test Folder",
5     "description": "This is a test folder.",
6     "createdAt": "2022-08-29T16:49:19.964Z",
7     "updatedAt": "2022-08-29T16:49:19.964Z",
8     "owner": "12345678",
9     "lastUpdatedBy": "12345678",
10     "lastRevision": 24977100955,
11     "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
12     "folder": null,
13     "auth": null,
14     "events": null,
15     "folders_order": [],
16     "order": [],
17     "variables": null
18   },
19   "meta": {
20     "action": "update",
21     "model": "folder"
22   },
23   "model_id": "65a99e60-8e0a-4b6e-b79c-7d8264cc5caa",
24   "revision": 24977103385
25 }

Updates a folder in a collection. For a complete list of properties, refer to the Folder entry in the Postman Collection Format documentation.

Note:

This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the name property). The endpoint does not update the entire resource.

Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

folderIdstringRequired

The folder's ID.

collectionIdstringRequired

The collection's ID.

Request

This endpoint expects an object.

namestringOptional

The folder's name.

descriptionstringOptional

The folder's description.

Response

Successful Response

dataobject

The folder’s updated information, including the updated properties. For a complete list of properties, refer to the Postman Collection Format documentation.

metamap from strings to any

A Postman-specific response that contains information about the internal performed operation.

model_idstring

The folder's ID.

revisiondouble

An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error