PUT
/
collections
/
{collection_id}
{
    "name": "string",
    "description": "string"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "type": "auto",
  "tags": [
    "<string>"
  ],
  "filters": {},
  "preview_asset": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "user_description": "<string>",
    "description": "<string>",
    "signature": 123,
    "updated": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "file_created": "2023-11-07T05:31:56Z",
    "file_modified": "2023-11-07T05:31:56Z",
    "timestamp": 123,
    "path": "<string>",
    "type": "IMAGE",
    "tags": [
      "<string>"
    ],
    "size_bytes": 123,
    "source": [
      "<string>"
    ],
    "objects": [
      "<any>"
    ],
    "transcription": "<string>",
    "rating": 123,
    "blurhash": "<string>",
    "palette": [
      [
        123
      ]
    ],
    "ocr": "<string>",
    "category": "<string>",
    "extension": "<string>",
    "license": "cc-by",
    "asset_metadata": {},
    "preview_images": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "path": "<string>",
        "thumbnail": "<string>",
        "created": "2023-11-07T05:31:56Z"
      }
    ],
    "texture_data": {},
    "integration_data": {},
    "proxy_path": "<string>",
    "ai_indexed": true,
    "comments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "content": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z"
      }
    ],
    "candid": true,
    "faces_present": true,
    "red_eye": true,
    "eyes_open": true,
    "people_posing": true,
    "blurry": true,
    "focused": true,
    "good_exposure": true,
    "players": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "number": 123,
        "image_blob": "<string>"
      }
    ]
  },
  "preview_image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "path": "<string>",
    "thumbnail": "<string>",
    "created": "2023-11-07T05:31:56Z"
  }
}
{
    "name": "string",
    "description": "string"
}

Path Parameters

​
collection_id
string
required

The id of the collection to be updated

Body

application/json
​
name
string

The new name for the collection

​
description
string

The new description for the collection

Response

200
application/json
The updated collection
​
id
string
required
​
name
string
required
​
description
string
required
​
type
enum<string>
required

An enumeration.

Available options:
auto,
user
​
tags
string[]
required
​
filters
object
required
​
preview_asset
object
​
preview_image
object