Skip to main content
PATCH
Update a preference
string
required
Registered preference key.
string
workspace (default), member, or user. Must match the registered scope. Workspace changes require preferences:read, preferences:write, and admin authority; personal changes require a signed-in person acting on their own preferences.
any
required
Complete replacement value matching the key’s schema. Arrays and objects are replaced, not merged. Include value explicitly, even when setting a nullable preference to null.
PUT is also supported with the same replacement behavior.

Returns

The updated Preference object. Invalid values return 422 without changing the preference. Repeating the same write preserves the same effective value.