Skip to main content
PATCH
/
api
/
v1
/
users
/
{user_id}
Update a user
curl --request PATCH \
  --url https://api.example.com/api/v1/users/{user_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role_id": 2,
  "is_active": true,
  "auth_provider": "<string>",
  "auth_provider_name": "<string>",
  "external_id": "<string>",
  "external_email": "<string>",
  "profile_data": {}
}
'
{
  "id": "<string>",
  "email": "<string>",
  "account_id": "<string>",
  "account_code": "<string>",
  "account_name": "<string>",
  "role_id": 123,
  "role_name": "<string>",
  "is_active": true,
  "auth_provider": "<string>",
  "email_verified": true,
  "created_at": "2023-11-07T05:31:56Z",
  "auth_provider_name": "<string>",
  "external_id": "<string>",
  "external_email": "<string>",
  "profile_data": {},
  "email_verified_at": "2023-11-07T05:31:56Z",
  "last_login": "2023-11-07T05:31:56Z"
}

Headers

​
authorization
string | null

Path Parameters

​
user_id
string
required

Body

application/json

Request schema for updating a user.

All fields are optional. Only provided fields will be updated. Note: account_id and password cannot be changed via this endpoint.

​
email
string<email> | null

User's email address

​
role_id
integer | null

Role ID (must exist)

Required range: x >= 1
​
is_active
boolean | null

Whether the user can log in

​
auth_provider
string | null

Authentication provider type ('password', 'oauth', 'saml')

​
auth_provider_name
string | null

Specific provider name (e.g., 'google', 'github')

​
external_id
string | null

External provider's user ID

​
external_email
string | null

Email from external provider

​
profile_data
Profile Data · object

Additional profile data from external provider

Response

Successful Response

Response schema for a single user.

Includes user details along with related account and role information.

​
id
string
required

User ID

​
email
string
required

User's email address

​
account_id
string
required

Account ID (UUID)

​
account_code
string
required

Human-readable account code in XX#### format (e.g., AB1234)

​
account_name
string
required

Account display name

​
role_id
integer
required

Role ID

​
role_name
string
required

Role name

​
is_active
boolean
required

Whether the user can log in

​
auth_provider
string
required

Authentication provider type ('password', 'oauth', 'saml')

​
email_verified
boolean
required

Whether the user's email is verified

​
created_at
string<date-time>
required

When the user was created

​
auth_provider_name
string | null

Specific provider name (e.g., 'google', 'github')

​
external_id
string | null

External provider's user ID

​
external_email
string | null

Email from external provider

​
profile_data
Profile Data · object

Additional profile data from external provider

​
email_verified_at
string<date-time> | null

When the email was verified

​
last_login
string<date-time> | null

Last successful login