Update part of a collection

PATCH

/collections/:collectionId

PATCH

/collections/:collectionId

$ curl -X PATCH https://api.getpostman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "collection": {
>     "auth": {
>       "type": "apikey",
>       "apikey": [
>         {
>           "key": "value",
>           "value": "{{apiKey}}"
>         },
>         {
>           "key": "key",
>           "value": "X-Api-Key"
>         },
>         {
>           "key": "in",
>           "value": "header"
>         }
>       ]
>     }
>   }
> }'

1 {
2   "collection": {
3     "id": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
4     "name": "Test Collection v2",
5     "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."
6   }
7 }

Updates specific collection information, such as its name, events, or its variables. For more information, see the Postman Collection Format documentation.

Updates specific collection information, such as its name, events, or its variables. For more information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

collectionIdstringRequired

The collection's ID.

Request

This endpoint expects an object.

collectionobjectOptional

Response

Successful Response

collectionobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error