Skip to main content

SetPreferencesResponse

Response after setting preferences

preferences object[]required

The updated preferences

  • Array [
  • keystringrequired

    The preference key (e.g., "ui.theme", "reader.zoom")

    Example: ui.theme
    updatedAtstring<date-time>required

    When the preference was last updated

    Example: 2024-01-15T18:45:00Z
    valuerequired

    The preference value

    valueTypestringrequired

    The value type: string, integer, float, boolean, or json

    Example: string
  • ]
  • updatedintegerrequired

    Number of preferences that were updated

    Possible values: >= 0

    Example: 3
    SetPreferencesResponse
    {
    "preferences": [
    {
    "key": "ui.theme",
    "updatedAt": "2024-01-15T18:45:00Z",
    "valueType": "string"
    }
    ],
    "updated": 3
    }