{% extends "docs/base.html" %} {% block docs_content %}

Update user

Update allowed non-activity user fields by username.

Endpoint

PUT /api/v1/users/{username}
Self

Request

JSON body supports partial fields like name and email. Use PUT /api/v1/users/{username}/activity for activity changes. is_active is still rejected here.

Usage

curl \
  --request PUT \
  --header "Authorization: Bearer $PEARING_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"name": "Alice Doe"}' \
  "$PEARING_API_URL/v1/users/alice"

Success

200 OK with the updated user. The response still includes activity and activity_updated_at.

{
  "uuid": "...",
  "username": "alice",
  "name": "Alice Doe",
  "activity": "",
  "activity_updated_at": null
}

Errors

Common auth errors are documented on the API overview page.

{% endblock %}