Docmost Octri Preview
POST/users/update

Update the authenticated user's profile

Updates one or more profile preferences or details for the authenticated user. Include only the fields you want to change; use confirmPassword when changing the email or setting a password. Set pageEditMode to read or edit to choose the default page view mode.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields

Profile details and preferences to update. All fields are optional.

avatarUrlstringoptional
URL or filename of the user avatar image.
confirmPasswordstringoptional
Required when changing email or setting a password. Verifies the user's current password.
emailstringoptional
Email address. Requires `confirmPassword` when changing.
fullPageWidthbooleanoptional
If `true`, the page editor uses the full browser width. If `false`, content is constrained to a max-width.
localestringoptional
BCP 47 language tag for UI localization (e.g. `en`, `fr`, `ja`).
namestringoptional
Display name.
pageEditModestringoptional
Default page view mode. `read`: pages open in read-only mode. `edit`: pages open in edit mode.
Allowed:readedit

3 status codes
200Returns the updated user profile.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when a submitted value fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the user is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when a submitted value fails validation. A 404 is returned when the user is not found. name must be 1 to 50 characters, confirmPassword must be 8 to 70 characters, and pageEditMode must be read or edit.