PATCH
/
users
/
{userId}
Update user
curl --request PATCH \
  --url https://api.authsignal.com/v1/users/{userId} \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "jane.smith@authsignal.com",
  "phoneNumber": "+123456789012",
  "username": "jane.smith@authsignal.com",
  "displayName": "Jane Smith"
}'
{
  "userId": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "username": "<string>",
  "displayName": "<string>",
  "custom": {}
}

Path Parameters

​
userId
string
required

The ID of the user.

Body

application/json
​
custom
object

A JSON object which can include any key/value pairs. Should be provided when using rules based on your own data points.

​
username
string

The username used as the primary identifier for passkeys, e.g. an email address.

​
displayName
string

The display name used as an optional secondary identifier for passkeys, e.g. the user's full name.

​
email
string

The user's email address.

​
phoneNumber
string

The user's phone number in E.164 format.

​
locale
string

The locale of the user.

Example:

"en"

Response

OK

​
userId
string

The user's ID.

​
email
string

The user's email address.

​
phoneNumber
string

The user's phone number in E.164 format.

​
username
string

The username used as the primary identifier for passkeys, e.g. an email address.

​
displayName
string

The display name used as an optional secondary identifier for passkeys, e.g. the user's full name.

​
custom
object

A JSON object which can include any key/value pairs. Should be provided when using rules based on your own data points.