Skip to content

UserPreferencesUpdateDto

Endpoints · All schemas

FieldRequiredDescription
albumsNoSee definition below
avatarNoSee definition below
castNoSee definition below
downloadNoSee definition below
emailNotificationsNoSee definition below
expectedRevisionNoThe revision these changes were made against. When it no longer matches the stored preferences the update is rejected with 409 and nothing is changed
foldersNoSee definition below
memoriesNoSee definition below
peopleNoSee definition below
privacyNoSee definition below
purchaseNoSee definition below
ratingsNoSee definition below
recentlyAddedNoSee definition below
savedSearchesNoSaved searches, replacing the whole list (at most 50). Only the account itself can change them
sharedLinksNoSee definition below
tagsNoSee definition below

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: AlbumsUpdate, AvatarUpdate, CastUpdate, DownloadUpdate, EmailNotificationsUpdate, FoldersUpdate, MemoriesUpdate, PeopleUpdate, PrivacyUpdate, PurchaseUpdate, RatingsUpdate, RecentlyAddedUpdate, SavedSearch, SharedLinksUpdate, TagsUpdate

{
  "properties": {
    "albums": {
      "$ref": "#/components/schemas/AlbumsUpdate"
    },
    "avatar": {
      "$ref": "#/components/schemas/AvatarUpdate"
    },
    "cast": {
      "$ref": "#/components/schemas/CastUpdate"
    },
    "download": {
      "$ref": "#/components/schemas/DownloadUpdate"
    },
    "emailNotifications": {
      "$ref": "#/components/schemas/EmailNotificationsUpdate"
    },
    "expectedRevision": {
      "description": "The revision these changes were made against. When it no longer matches the stored preferences the update is rejected with 409 and nothing is changed",
      "type": "string"
    },
    "folders": {
      "$ref": "#/components/schemas/FoldersUpdate"
    },
    "memories": {
      "$ref": "#/components/schemas/MemoriesUpdate"
    },
    "people": {
      "$ref": "#/components/schemas/PeopleUpdate"
    },
    "privacy": {
      "$ref": "#/components/schemas/PrivacyUpdate"
    },
    "purchase": {
      "$ref": "#/components/schemas/PurchaseUpdate"
    },
    "ratings": {
      "$ref": "#/components/schemas/RatingsUpdate"
    },
    "recentlyAdded": {
      "$ref": "#/components/schemas/RecentlyAddedUpdate"
    },
    "savedSearches": {
      "description": "Saved searches, replacing the whole list (at most 50). Only the account itself can change them",
      "items": {
        "$ref": "#/components/schemas/SavedSearch"
      },
      "maxItems": 50,
      "type": "array"
    },
    "sharedLinks": {
      "$ref": "#/components/schemas/SharedLinksUpdate"
    },
    "tags": {
      "$ref": "#/components/schemas/TagsUpdate"
    }
  },
  "type": "object"
}