Update the logged-in user's preferences.
Patch-merges the supplied fields into the user's `preferences` JSON. Omitted keys are left untouched server-side. Used for notification settings, sound preferences, hide flags, and onboarding-Todo dismissals. Unknown keys (at any level) are rejected with 400. `dismissed.*` groups per-user UX opt-outs (todos, workspace-setup prompts, etc). The server merges the `dismissed` object one level deep, so writing one inner key preserves the others. For todos: the resolver filters out unknown ids and ids that aren't marked `dismissible: true` in `@config/todos.js` — so a tampered client cannot dismiss `verifyEmail` and slip past the verification grace gate.
Patch-merges the supplied fields into the user's preferences JSON.
Omitted keys are left untouched server-side. Used for notification
settings, sound preferences, hide flags, and onboarding-Todo
dismissals. Unknown keys (at any level) are rejected with 400.
dismissed.* groups per-user UX opt-outs (todos, workspace-setup
prompts, etc). The server merges the dismissed object one level
deep, so writing one inner key preserves the others. For todos:
the resolver filters out unknown ids and ids that aren't marked
dismissible: true in @config/todos.js — so a tampered client
cannot dismiss verifyEmail and slip past the verification grace
gate.
Authorization
bearerAuth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/users/preferences" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "middleName": "string", "lastName": "string", "company": "string", "userName": "string", "displayName": "string", "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67", "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779", "color": "#ffffff", "email": "user@example.com", "isEmailVerified": false, "hasPassword": false, "allowOauthAutolink": true, "mfaEnabled": false, "mfaType": "totp", "status": "active", "accountType": "standard", "globalRoles": [ "string" ], "preferences": {}, "language": "en", "externalIds": {}, "lastSeen": "2019-08-24T14:15:22Z", "hasUsedTrial": false, "hasUsedDemo": false, "hasSeen": [ "string" ], "awards": [ "staff" ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}