Skip to main content
Update a user’s profile information. Providing a parameter will overwrite the existing value.

PATCH /users/:id

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID or alias of the user to update.

Request Body

ParameterTypeRequiredDescription
aliasstringNoNew alias for the user. Must be globally unique.
namestringNoUser’s full name.
descriptionstringNoA short bio or description.
urlstringNoURL to a personal website or profile.

Response

Returns an empty JSON object upon success.

Example

{
  "name": "Jane Doe-Smith",
  "description": "AI Researcher"
}

Identifier

The id parameter accepts a UUID, alias, or me.

Permissions

Only the user themselves can update their profile. Requests targeting a different user return 403 Forbidden.
The alias field can only be set once. Attempting to change an existing alias returns an error.