Skip to main content

Merge My Preferences

PATCH 
/api/me/preferences

Updates the authenticated user's preferences, merging object fields into what is already saved instead of replacing them. Scalar fields are written as sent.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Merge rules:

  • table_preferences — merged per list, then per setting. Sending null for a list removes it; null for a setting removes that setting.
  • page_versions — merged per page; null removes the page.
  • recents — each list sent (destinations, searches, entities) replaces that list; lists not sent are kept.
  • Sending any object field itself as null clears it.

Authentication: Requires Bearer token. Any authenticated user can update their own preferences.

Body fields (all optional):

  • show_internal_ids, nav_rail_collapsed, supplier_message_notifications, pulse_enabled, pulse_collapsed (boolean)
  • density (string) — compact (default) or comfortable.
  • landing_page (string) — dashboard, last_visited or path.
  • landing_path (string|null) — required when landing_page is path. Must start with / and contain only letters, digits, -, _ and / (max 255).
  • default_warehouse_id (integer|null) — an active (not archived) warehouse, or null to clear.
  • table_preferences (object|null) — up to 200 lists per request; each value is an object with per_page (integer 1–500), view_mode (table|grid) and column_display (column → absolute|relative), or null. Unknown settings are ignored.
  • page_versions (object|null) — page key → v2|v3.
  • recents.destinations[] — title (required, max 120), path (required, max 255), icon, badgeKey (max 10 items).
  • recents.searches[] — query (required, max 200), timestamp (required, integer ms) (max 10 items).
  • recents.entities[] — id (required, integer), type (required), name (required), detail, path (required), timestamp (required) (max 10 items).

Request​

Responses​

OK

Response Headers
    Content-Type