Update part of a collection
PATCH {{baseUrl}}/collections/{{collectionId}}
Updates specific collection information, such as its name, events, or its variables. For more information about the auth
, variables
, and events
properties, refer to the [collection.json schema file]
- For
variables
, refer to"#/definitions/variable"
. - For
auth
, refer to"#/definitions/auth-attribute"
. - For
events
, refer to"#/definitions/event"
.
For more information about the Collection Format, see the [Qodex Collection Format documentation]
Request Body
{"collection"=>{"info"=>{"name"=>"{{collectionName}}", "description"=>"{{collectionDescription}}"}, "variables"=>[], "auth"=>{}, "events"=>[]}}
RESPONSES
status: OK
{"collection":{"id":"12ece9e1-2abf-4edc-8e34-de66e74114d2","name":"Test Collection v2","description":"This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client."}}