Update a collection
PUT Update a collection
Method: PUT
URL: https://api.getpostman.com/collections/[collectionId]
Description
Updates a collection using the Postman Collection v2 schema format. Include a collection object in the request body that contains the following required properties:
-
info— An object that contains the following properties: -
name— A string value that contains the collection's name. -
schema— A string that contains a URL to the collection's schema. For example, thehttps://schema.getpostman.com/collection/v1URL. -
item— An object that contains the HTTP request and response information. -
request— An object that contains the collection's request information. For a complete list of values, refer to thedefinitions.requestentry in the collection.json schema file. If you pass an empty object for this value, the system defaults to an untitled GET request.Note:
-
For a complete list of available property values for this endpoint, use the following references available in the collection.json schema file:
-
infoobject — Use thedefinitions.infoentry. -
itemobject — Use thedefinitions.itemsentry. -
For all other possible values, refer to the collection.json schema file.
Important
Use caution when using this endpoint. The system will replace the existing collection with the values passed in the request body.
Header
| Key | Value |
|---|---|
| Content-Type | application/json |
Request Body (Json)
{
"collection": {
"info": {
"name": "collectionName",
"schema": "collectionSchemaUrl"
},
"item": [
{
"request": {}
}
]
}
}