PUT https://api.getpostman.com/collections/{{collectionId}}
Updates a collection using the [Qodex Collection v2 schema format] Include a Note: Use caution when using this endpoint. The system will replace the existing collection with the values passed in the request body.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, the https://schema.getQodex.com/collection/v1
URL.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 the definitions.request
entry in the [collection.json schema file] If you pass an empty object for this value, the system defaults to an untitled GET request.
info
object — Use the definitions.info
entry.item
object — Use the definitions.items
entry.Important
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Content-Type
|
string |
RESPONSES
status OK
{
"collection": {
"id": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
"name": "Test Collection",
"uid": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
}
} |
ENDPOINTS