Skip to main content
PATCH
/
v1
/
users
/
{id}
Update a User
curl --request PATCH \
  --url https://api.us.lexful.app/v1/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "role": "system_admin",
  "account_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "organization_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "role": "system_admin",
  "account_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "organization_scopes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "first_name": "<string>",
  "last_name": "<string>",
  "external_ids": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_by": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token

​
X-Account-ID
string
header
required

Account ID

Path Parameters

​
id
string<uuid>
required

User ID

Body

application/json
​
email
string<email>

User email address

Maximum string length: 255
​
first_name
string | null

User first name

Required string length: 1 - 100
​
last_name
string | null

User last name

Required string length: 1 - 100
​
role
enum<string>

User role

Available options:
system_admin,
system_support,
admin,
support,
viewer
​
account_scopes
(string<uuid> | enum<string>)[]

Array of account IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

​
organization_scopes
(string<uuid> | enum<string>)[]

Array of organization IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

Response

Default Response

​
id
string<uuid>
required

User unique identifier

​
account_id
string<uuid>
required

Account ID this user belongs to

​
email
string<email>
required

User email address

​
role
enum<string>
required

User role

Available options:
system_admin,
system_support,
admin,
support,
viewer
​
account_scopes
(string<uuid> | enum<string>)[]
required

Array of account IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

​
organization_scopes
(string<uuid> | enum<string>)[]
required

Array of organization IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

​
first_name
string | null

User first name

​
last_name
string | null

User last name

​
external_ids
object

External system ID mappings

​
created_at
string<date-time>

User creation timestamp

​
updated_at
string<date-time>

Last update timestamp

​
created_by
string

User ID who created this user

​
updated_by
string

User ID who last updated this user

​
deleted_at
string<date-time> | null

Deletion timestamp