Add items to catalog collections

v1.0.0

This endpoint adds assets to a catalog collection. It also automatically adds the assets to the user's account's catalog.

Input

{
  "type": "object",
  "properties": {
    "collection_id": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "asset"
        ],
        "properties": {
          "asset": {
            "type": "object",
            "required": [
              "type"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "type": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "collection_id",
    "items"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Catalog collection",
  "required": [
    "created_time",
    "id",
    "name",
    "role_assignments",
    "total_item_count",
    "updated_time",
    "visibility"
  ],
  "properties": {
    "cover_asset": {
      "type": "object",
      "description": "Metadata about an item that is part of a collection",
      "required": [
        "asset",
        "created_time",
        "id"
      ],
      "properties": {
        "asset": {
          "type": "object",
          "required": [
            "type"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "type": {
              "type": "string",
              "enum": [
                "image",
                "video",
                "audio",
                "editorial-image",
                "editorial-video"
              ]
            }
          }
        },
        "collection_ids": {
          "type": "array",
          "description": "The collection IDs that this asset belongs to",
          "items": {
            "type": "string"
          }
        },
        "created_time": {
          "type": "string",
          "format": "date-time"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "created_time": {
      "type": "string",
      "format": "date-time"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "role_assignments": {
      "type": "object",
      "description": "List of role assignments for a catalog collection",
      "required": [
        "collection_id",
        "roles"
      ],
      "properties": {
        "collection_id": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "editors": {
              "type": "array",
              "items": {
                "type": "object",
                "description": "A user that has access to a catalog collection",
                "required": [
                  "id",
                  "type",
                  "email"
                ],
                "properties": {
                  "email": {
                    "type": "string"
                  },
                  "id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "USER"
                    ]
                  }
                }
              }
            },
            "owners": {
              "type": "array",
              "items": {
                "type": "object",
                "description": "A user that has access to a catalog collection",
                "required": [
                  "id",
                  "type",
                  "email"
                ],
                "properties": {
                  "email": {
                    "type": "string"
                  },
                  "id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "USER"
                    ]
                  }
                }
              }
            },
            "viewers": {
              "type": "array",
              "items": {
                "type": "object",
                "description": "A user that has access to a catalog collection",
                "required": [
                  "id",
                  "type",
                  "email"
                ],
                "properties": {
                  "email": {
                    "type": "string"
                  },
                  "id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "USER"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    },
    "total_item_count": {
      "type": "number"
    },
    "updated_time": {
      "type": "string",
      "format": "date-time"
    },
    "visibility": {
      "type": "string",
      "enum": [
        "private",
        "public"
      ]
    }
  }
}