PinnedCollectionRef

Endpoints · All schemas

Field	Required	Description
id	Yes	Opaque pin ID chosen by the client and retained across reorders
kind	Yes	string
targetId	Yes	Target UUID, saved-search name, or built-in ID. Null retains an existing unavailable pin by its opaque ID

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.

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Opaque pin ID chosen by the client and retained across reorders",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "kind": {
      "enum": [
        "album",
        "smart-album",
        "saved-search",
        "person",
        "pet",
        "memory",
        "builtin"
      ],
      "type": "string"
    },
    "targetId": {
      "description": "Target UUID, saved-search name, or built-in ID. Null retains an existing unavailable pin by its opaque ID",
      "maxLength": 100,
      "minLength": 1,
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "id",
    "kind",
    "targetId"
  ],
  "type": "object"
}