Update a Collection

This endpoint updates a Collection based on the Collection ID. Use the assets object to provide the updated list of assets for this collection, any assets in the collection who's ID is not provided will be removed from the collection. The same applies for Security Templates. Requests should only contain the properties for which there are changes to the data, otherwise omit.

SecurityOAuth2
Request
path Parameters
collectionId
required
string <uuid> = 36 characters

The Collection Identifier.

Example: f45c87aa-2ff7-4f2c-9c38-9d69554a1c8a
header Parameters
content-type
string
Example: application/json
Authorization
string
Example: Bearer <token>
Request Body schema: application/json
type
string

The type of Collection.

Enum: "shared" "private"
name
string [ 5 .. 50 ] characters
parent
string or null <uuid>

If nesting a Collection within a Collection, provide the Collection ID of the lowest level parent Collection. The new Collection will be created within it. Omit if not nesting Collections.

assets
Array of arrays or null or null

An array of object ID's for assets that you wish to add to the Collection. Assets must be available in the system, and user must have permission to view the assets. Omit if creating an empty Collection.

securityTemplates
Array of arrays or null or null

If Creating a Shared Collection, one or more Security Templates must be assigned. Omit when collectionType is Private.

Responses
200

Successful Request. Collection Updated Successfully.

400

One or more required parameters are missing or invalid.

401

Authentication failed (unauthorized).

403

Forbidden. You do not have permissions to perform this action, or your connection information is not correct.

503

The server is too busy to handle the request.

patch/collections/{collectionId}
Request samples
application/json
{
  • "type": "shared",
  • "name": "Fall Jackets 2024",
  • "parent": "a6e4f3ba-5c18-4daa-a630-463420e006bd",
  • "assets": [
    ],
  • "securityTemplates": [
    ]
}
Response samples
application/json
{
  • "id": "f45c87aa-2ff7-4f2c-9c38-9d69554a1c8a",
  • "type": "shared",
  • "name": "Fall Jackets 2024",
  • "parent": "a6e4f3ba-5c18-4daa-a630-463420e006bd",
  • "createdBy": {
    },
  • "lastUpdated": {
    },
  • "securityTemplates": [
    ],
  • "contents": {
    }
}