Create Collection

POST

/collections

Collections

This endpoint allows you to create collections using the Postman Collection v2 format. For more information about the v2 schema, check the format here.

On successful creation of the collection, the response returns the collection name, id and the uid.

You can also specify the context of a workspace to create a collection in directly by passing the workspace as a query param.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.getpostman.com/collections' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collection": {
        "info": {
            "description": "This is just a sample collection.",
            "name": "Sample Collection {{$randomInt}}",
            "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
        },
        "item": [
            {
                "item": [
                    {
                        "name": "Sample POST Request",
                        "request": {
                            "body": {
                                "mode": "raw",
                                "raw": "{\"data\": \"123\"}"
                            },
                            "description": "This is a sample POST Request",
                            "header": [
                                {
                                    "key": "Content-Type",
                                    "value": "application/json"
                                }
                            ],
                            "method": "POST",
                            "url": "https://postman-echo.com/post"
                        }
                    }
                ],
                "name": "This is a folder"
            },
            {
                "name": "Sample GET Request",
                "request": {
                    "description": "This is a sample GET Request",
                    "method": "GET",
                    "url": "https://postman-echo/get"
                }
            }
        ]
    }
}'

Response Example

200 - Create Collection in a Workspace

{
  "collection": {
    "id": "2412a72c-1d8e-491b-aced-93809c0e94e9",
    "name": "Sample Collection",
    "uid": "5852-2412a72c-1d8e-491b-aced-93809c0e94e9"
  }
}

Request

Body Params application/json

collection

object

optional

info

object

optional

item

array [object {2}]

optional

Examples

Responses

🟢200Create Collection in a Workspace

application/json

Body

collection

object

optional

string

optional

Example:

2412a72c-1d8e-491b-aced-93809c0e94e9

name

string

optional

Example:

Sample Collection

uid

string

optional

Example:

5852-2412a72c-1d8e-491b-aced-93809c0e94e9

🟠400Malformed Request

Modified at 2023-08-15 05:41:03

All Collections

Create a Fork