Create a Collection

Use this endpoint to create a Collection of Assets and assign Assets to the Collection.

SecurityOAuth2
Request
header Parameters
content-type
string
Example: application/json
Authorization
string
Example: Bearer <token>
Request Body schema: application/json
collectionType
string
Enum: "shared" "private"
name
string
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 Created 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.

post/collections
Request samples
application/json
{
  • "collectionType": "shared",
  • "name": "Fall Jackets 2024",
  • "parent": "a6e4f3ba-5c18-4daa-a630-463420e006bd",
  • "assets": [
    ],
  • "securityTemplates": [
    ]
}
Response samples
application/json
{
  • "collectionId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}