Skip to main content
PATCH
/
v1
/
users
/
{userId}
Update user
curl --request PATCH \
  --url https://api.ledger.so/v1/users/{userId} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "metadata": {}
}
'
{
  "object": "user",
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "applicationStatus": "notStarted",
  "createdAt": 123,
  "metadata": {}
}

Authorizations

​
Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

​
userId
string
required

The user ID

Body

application/json
​
firstName
string
​
lastName
string
​
email
string<email>
​
metadata
object

Response

User updated

​
object
enum<string>
required
Available options:
user
​
id
string
required
​
firstName
string
required
​
lastName
string
required
​
email
string
required
​
applicationStatus
enum<string>
required
Available options:
notStarted,
pending,
needsInformation,
needsVerification,
manualReview,
approved,
denied,
locked,
canceled
​
createdAt
integer
required
​
metadata
object