Skip to content

Set the self-edit settings (admin)

PATCH
/admin/system/users

Saves all five self-edit settings and returns the values you sent.

You need to be signed in with system.config.write or system.admin granted globally; others get 403. Without a session cookie or bearer token that identifies you, the answer is 401, whether or not public mode is on. A body that isn’t valid JSON, or a known setting sent as anything other than a boolean or null, gets a plain-text 400 before sign-in is checked.

Every field is written each time: one you leave out or send as null is saved as false, which locks it, so {} locks all five. Unknown keys are ignored.

The five settings are saved one after another, not together. If saving fails partway, the earlier ones stay changed and the answer is a plain-text 500, and no server is asked to drop its cached copy. After all five are saved, this server drops its copy and asks the others to, but that request can fail. Either way a server can keep serving older settings until its copy is dropped, for example by a later save or a restart, while a server without a cached copy reads whatever is stored, even a partial save. Two saves at the same time can leave a mix of both. No audit entry is recorded.

Whether each of the five lockable profile fields can be changed by its owner; true means it can.

object
display_name
required
boolean
bio
required
boolean
avatar_url
required
boolean
location
required
boolean
website_url
required
boolean

The settings you sent, not read back.

Whether each of the five lockable profile fields can be changed by its owner; true means it can.

object
display_name
required
boolean
bio
required
boolean
avatar_url
required
boolean
location
required
boolean
website_url
required
boolean

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed