Update Collection
PUT https://api.getpostman.com/collections/{{collectionUid}}
This endpoint allows you to update an existing collection using the Qodex 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 orapikey
URL query parameter.
Note: Please be careful when trying to update the collection, as the existing collection will be replaced by the request body.
Request Body
{"collection"=>{"info"=>{"name"=>"{{collectionName}}", "description"=>"{{collectionDescription}}", "schema"=>"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"}, "item"=>[{"name"=>"{{collectionFolderName}}", "_postman_id"=>"b5e8d7dd-909c-4ba7-aef4-8609bc50b586", "description"=>"This is a sample POST Request", "request"=>{"url"=>"echo.getpostman.com/post", "method"=>"POST", "header"=>[{"key"=>"Content-Type", "value"=>"application/json", "description"=>""}]}, "body"=>{"mode"=>"raw", "raw"=>"{\n\t\"data\": \"123\"\n}"}}]}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"collection":{"id":"12ece9e1-2abf-4edc-8e34-de66e74114d2","name":"Sample Collection","uid":"12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"}}