v1

latestOpenAPI 3.0.02026-07-131091452.6 MB

catalog

Update collection metadata

This endpoint updates the metadata of a catalog collection.

patch/v2/catalog/collections/{collection_id}

Path parameters

collection_idstring required

ID of collection that needs to be modified

Request body

namestring

visibility'private' | 'public'

Example request

{
  "name": "My Collection",
  "visibility": "public",
  "cover_asset": {
    "id": "123"
  }
}

Response

idstring required

namestring required

total_item_countnumber required

created_timestring date-time required

updated_timestring date-time required

visibility'private' | 'public' required

Example response

{
  "id": "126351028",
  "name": "My collection",
  "cover_asset": {
    "id": "123",
    "asset": {
      "id": "1690105108",
      "type": "image",
      "name": "Young couple playing tennis at the court"
    },
    "created_time": "2021-06-10T13:26:09-04:00"
  },
  "total_item_count": 2,
  "created_time": "2021-05-20T16:15:22-04:00",
  "updated_time": "2021-06-10T13:26:09-04:00",
  "visibility": "public",
  "role_assignments": {
    "collection_id": "126351028",
    "roles": {
      "owners": [
        {
          "id": "321",
          "type": "USER",
          "email": "userOne@org.com"
        }
      ],
      "editors": [
        {
          "id": "987",
          "type": "USER",
          "email": "userTwo@org.com"
        }
      ],
      "viewers": []
    }
  }
}