Skip to main content
PUT
Update Collection

Authorizations

Authorization
string
header
required

JWT in Authorization header. 'Bearer ' prefix optional.

Path Parameters

collection_id
string<uuid>
required

Body

application/json

API request schema for updating a collection

name
string | null

New name for the collection

description
string | null

New description for the collection

appearance_settings
AppearanceSettingsUpdateRequest · object | null

Appearance settings

icon_attachment_id
string<uuid> | null

Attachment ID for icon image

clear_icon_attachment
boolean
default:false

Clear the icon attachment

background_attachment_id
string<uuid> | null

Attachment ID for background image

clear_background_attachment
boolean
default:false

Clear the background attachment

Response

Successful Response

API response schema for creating a collection

id
string<uuid>
required

Collection ID

name
string
required

Collection name

actions
integer
required

User's permission bitmap on this collection

project_id
string<uuid>
required

Project ID

appearance_settings
AppearanceSettingsResponse · object
required

Appearance settings with attachments

created
string<date-time>
required

Creation timestamp

updated
string<date-time>
required

Last update timestamp

description
string | null

Collection description

created_by_user_id
string<uuid> | null

User who created this collection

created_by_user
UserInfo · object | null

User who created this collection

num_assets
integer
default:0

Number of assets in the collection

num_directories
integer
default:0

Number of directories in the collection