Update an existing user account

Modifies the details of an existing user account identified by accountId.

The request allows updating user information such as firstname, surname and email.

Note:

  • Partial updates are supported, meaning only the fields provided in the request body will be updated.
  • This endpoint does not support updating sensitive attributes like dob or sex.
  • email is the users communication email. You cannot change their login credentials.

Required Scope: write:accounts

Path Params
string
required

The requested account's ID

Body Params
string
length ≤ 64

The user's first name.

string
length ≤ 64

The user's last name.

string
length ≤ 100

The user's email address.

string
length ≤ 8

The user's nickname.

string

The user's mobile phone number.

commPreferences
object
uuid

The user's facility. This can be changed to any facility in the authenticated clients facility claims.

string

The user's country of origin. ISO 3166 aplha-2 code.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json