POST /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-Keyrequest header orapikeyURL query parameter.
Servers
- https://api.getpostman.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
collection |
Object | No | |
collection.info |
Object | No | |
collection.info.name |
String | No | |
collection.info.description |
String | No | |
collection.info.schema |
String | No | |
collection.item[] |
Array | No | |
collection.item[].name |
String | No | |
collection.item[].item[] |
Array | No | |
collection.item[].item[].name |
String | No | |
collection.item[].item[].request |
Object | No | |
collection.item[].item[].request.method |
String | No | |
collection.item[].item[].request.description |
String | No | |
collection.item[].item[].request.url |
String | No | |
collection.item[].item[].request.header[] |
Array | No | |
collection.item[].item[].request.header[].key |
String | No | |
collection.item[].item[].request.header[].value |
String | No | |
collection.item[].item[].request.body |
Object | No | |
collection.item[].item[].request.body.mode |
String | No | |
collection.item[].item[].request.body.raw |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.