AlbumOrderDto

Endpoints · All schemas

Field	Required	Description
albumIds	Yes	Every item of the group, in the order to show them. Must be exactly the group as it is now; a group that changed since the client loaded it is refused with 409.
parentId	Yes	Collection whose albums are ordered, or null for a top-level group (collections, albums on their own, or shared spaces)

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "albumIds": {
      "description": "Every item of the group, in the order to show them. Must be exactly the group as it is now; a group that changed since the client loaded it is refused with 409.",
      "items": {
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        "type": "string"
      },
      "maxItems": 5000,
      "minItems": 1,
      "type": "array"
    },
    "parentId": {
      "description": "Collection whose albums are ordered, or null for a top-level group (collections, albums on their own, or shared spaces)",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  },
  "required": [
    "albumIds",
    "parentId"
  ],
  "type": "object"
}