AlbumSourceDto

Endpoints · All schemas

Field	Required	Description
deviceKey	No	Set only when sourceId is device-local (an iOS localIdentifier, an Android bucket); null otherwise
kind	Yes	See definition below
name	Yes	The name of the album or folder on the phone
sourceId	Yes	The source on the phone: the iOS album PHCloudIdentifier when available, else its localIdentifier; on Android "<bucketId>:<relativePath>"

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.

Field definitions: AlbumSourceKind

{
  "properties": {
    "deviceKey": {
      "description": "Set only when sourceId is device-local (an iOS localIdentifier, an Android bucket); null otherwise",
      "maxLength": 256,
      "minLength": 1,
      "nullable": true,
      "type": "string"
    },
    "kind": {
      "$ref": "#/components/schemas/AlbumSourceKind"
    },
    "name": {
      "description": "The name of the album or folder on the phone",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "sourceId": {
      "description": "The source on the phone: the iOS album PHCloudIdentifier when available, else its localIdentifier; on Android \"<bucketId>:<relativePath>\"",
      "maxLength": 1024,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "kind",
    "name",
    "sourceId"
  ],
  "type": "object"
}