Update a Collection.

Update a Collection's attributes or assigned Assets. The list of existing assets is replaced with assets provided in the call. Assets in the collection are referenced by Asset FileID therefore the collectionDocument must contain asset's FileID.

The User editing the Collection must have the Collection Security Role Privilege. The User must have View access to the Assets that are being added to or removed from the Collection.

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
id
required
string

Specify Collection ID

header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body must be a JSON object.

collectionType
string

Type of the collection.

Enum: "secured" "private"
name
string

Name of the collection

collectionDocument
Array of strings <uuid>

List of fileIDs to be added to collection. This list will replace the current set of assets in the collection.

Responses
200

Successful operation

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

returns JSON object with error description.

patch/collection/{id}
Request samples
application/json
{
  • "collectionType": "secured",
  • "name": "Photo Collection",
  • "collectionDocument": [
    ]
}
Response samples
application/json
{
  • "message": "Collection update was successful"
}