Create a folder

POST

/collections/:collectionId/folders

POST

/collections/:collectionId/folders

curl -X POST https://api.postman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/folders \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Test Folder",
  "description": "This is a test collection folder."
}'

{
  "data": {
    "id": "65a99e60-8e0a-4b6e-b79c-7d8264cc5caa",
    "name": "Test Folder",
    "order": [],
    "owner": "12345678",
    "folder": null,
    "folders": [],
    "requests": [],
    "createdAt": "2022-08-29T16:49:19.964Z",
    "updatedAt": "2022-08-29T16:49:19.964Z",
    "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
    "description": "This is a test collection folder.",
    "folders_order": [],
    "lastUpdatedBy": "12345678"
  },
  "meta": {
    "action": "import",
    "model": "folder"
  },
  "model_id": "65a99e60-8e0a-4b6e-b79c-7d8264cc5caa",
  "revision": 24994132707
}

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

You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the requests field and the list of request objects in the request body. For more information, see the provided example.

Note:

It is recommended that you pass the name property in the request body. If you do not, the system uses a null value. As a result, this creates a folder with a blank name.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

collectionIdstringRequired

The collection's ID.

Request

This endpoint expects an object.

namestringOptional

The folder’s name. It is recommended that you pass the name property in the request body. If you do not, the system uses a null value. As a result, this creates a folder with a blank name.

folderstringOptionalformat: "uid"

The ID of a folder in which to create the folder.

Response

Successful Response

dataobjectOptional

Information about the collection folder. For a complete list of properties, refer to the Postman Collection Format documentation.

metamap from strings to anyOptional

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

model_idstringOptional

The folder's ID.

revisiondoubleOptional

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

500

Internal Server Error