Skip to main content
PUT
/
v2
/
users
/
{id}
Update User
curl --request PUT \
  --url https://public.api.serval.com/v2/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "avatarUrl": "<string>",
  "locale": "<string>",
  "phoneNumber": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "name": "<string>",
    "avatarUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "deactivatedAt": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "locale": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
email
string | null
​
firstName
string | null
​
lastName
string | null
​
role
enum<string> | null
Available options:
USER_ROLE_UNSPECIFIED,
USER_ROLE_ORG_MEMBER,
USER_ROLE_ORG_ADMIN,
USER_ROLE_ORG_GUEST
​
avatarUrl
string | null
​
authMethod
enum<string> | null

Specifies the authentication method for a user. If unset, the org default applies. Set to MAGIC_LINK to allow the user to bypass SSO (e.g. guest or break-glass accounts).

Available options:
USER_AUTH_METHOD_UNSPECIFIED,
USER_AUTH_METHOD_MAGIC_LINK
​
locale
string | null

BCP 47 language tag

​
phoneNumber
string | null

Response

Success

​
data
data · object