Prefs
Package prefs is your own settings — theme, density, pinned nav — following you across every Hanzo app.
Package prefs is your own settings — theme, density, pinned nav — following you across every Hanzo app.
| Base URL | https://api.hanzo.ai |
| Operations | 2 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
prefs
GET /v1/prefs
Returns the signed-in caller's OWN preference document — the theme, density and pinned nav that follow them across every Hanzo surface. There is no path to another user's preferences: not for an org admin, not for a platform SuperAdmin, because the subject is built from the validated credential and is the mandatory predicate on the read. A caller who has never saved anything gets an empty document at 200, never a 404, so the user menu always renders.
PATCH /v1/prefs
Save the preference keys your surface owns, leaving every other key alone
Merges a JSON object key-wise into the signed-in caller's OWN preference document and answers with the whole document after the merge, so a surface saves theme without having to send back the density another surface owns. The merge is SHALLOW and the key space is open: an unnamed key is left untouched, a named key is replaced whole, and a key sent with a null value is DELETED. The subject is the <owner>/<name> identity built from the validated credential and is the mandatory predicate on the write, so there is no path to another user's preferences — not for an org admin, not for a platform SuperAdmin. Fails closed: no validated principal is 403; an empty body or a literal null is 400; and a patch or a resulting document over 16 KiB or 128 keys is 413.
How is this guide?