Skip to content
getgeolens.com
GeoLens DocsEarly release

Update User

PATCH
/admin/users/{user_id}
 
curl --request PATCH \
  --url https://example.com/api/admin/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "is_active": true, "role": "example" }'

Update a user’s fields and/or role (admin only).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
user_id
required
User Id
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
UserUpdate
object
email
Any of:
string format: email
is_active
Any of:
boolean
role
Any of:
string
<= 50 characters
Example generated
{
  "email": "[email protected]",
  "is_active": true,
  "role": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
UserResponse
object
id
required
Id
string format: uuid
username
required
Username
string
email
required
Any of:
string
is_active
required
Is Active
boolean
status
required
Status

Account status: active, pending, suspended, or deactivated.

string
Allowed values: active pending suspended deactivated
last_login_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
roles
required
Roles

Assigned role names, e.g. [‘admin’, ‘editor’]

Array<string>
Example 
{
  "status": "active"
}

400

Section titled “400 ”

Bad request — invalid query parameters or payload

401

Section titled “401 ”

Unauthorized — missing or invalid credentials

403

Section titled “403 ”

Forbidden — caller lacks access to this resource

404

Section titled “404 ”

Not found

422

Section titled “422 ”

Validation error

500

Section titled “500 ”

Internal server error