PUT /collections/{collection_uid}

This endpoint allows you to update an existing collection using the Postman Collection v2 format. For more information about the v2 schema, check the format here.

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

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

Note: Please be careful when trying to update the collection, as the existing collection will be replaced by the request body.

Servers

https://api.getpostman.com

Path parameters

Name	Type	Required	Description
`collection_uid`	String	Yes

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
`collection`	Object	No
`collection.info`	Object	No
`collection.info.name`	String	No
`collection.info._postman_id`	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.