Skip to content
em sa em sa

Patch User

PATCH
/api/admin/users/{user_id}
 
curl --request PATCH \
  --url https://example.com/api/admin/users/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "first_name": "example", "last_name": "example", "avatar_url": "example", "email": "example" }'

Update mutable profile fields on a canonical user.

Admin only. Only provided fields are updated (partial update semantics). Returns 404 if not found, 422 if UUID invalid.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
user_id
required
User Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
PatchUserRequest
object
first_name
Any of:
string
last_name
Any of:
string
avatar_url
Any of:
string
email
Any of:
string
Example generated
{
  "first_name": "example",
  "last_name": "example",
  "avatar_url": "example",
  "email": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
UserResponse
object
id
required
Id
string
email
required
Any of:
string
display_name
required
Display Name
string
avatar_url
required
Any of:
string
status
required
Status
string
created_at
required
Created At
string
updated_at
required
Updated At
string
Example generated
{
  "id": "example",
  "email": "example",
  "display_name": "example",
  "avatar_url": "example",
  "status": "example",
  "created_at": "example",
  "updated_at": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}