UpdateCollectionRequest

Request payload for updating a collection.

Should be used in the UpdateCollection endpoint. Only the fields supplied in the request payload will have an effect on a collection.

{
  "collectionId": "23785995",
  "name": "new name",
  "comment": "this is a new comment"
}

{
  "collectionId": "23785995",
  "add": [
    {
      "type": "album",
      "id": "1234"
    }
  ]
}

{
  "collectionId": "23785995",
  "move": {
    "fromStart": 0,
    "fromEnd": 5,
    "to": 20
  }
}

{
  "collectionId": "23785995",
  "remove": [0, 1, 2, 6]
}

Field	Type	Req.	OpenS.	Details
`collectionId`	string	Yes	Yes	The collection ID.
`name`	string	No	Yes	The human-readable name of the collection. Cannot be an empty string.
`comment`	string	No	Yes	The collection comment.
`public`	boolean	No	Yes	`true` if the collection should be visible to all users, `false` otherwise.
`add`	CollectionItemID[]	No	Yes	Add the specified items to the collection. Items are appended to the tail of the collection.
`move`	MoveRange	No	Yes	Move items from the original position to another in the collection.
`remove`	Array of integer	No	Yes	Remove the items at the specified positions from the collection.

Only one of add, move, and remove can be non-empty in a single request.