Skip to main content

Update user

The endpoint provides functionality for user modification.

The required values are the userExtId retrieved upon user creation, and the instanceId of the customer.

For authorization, a JWT is required.

HTTP request

PATCH https://${instanceId}${userExtId}


instanceId StringpathRequired The ID of the customer instance
userExtId UUIDpathRequired The ID of the searched user

Request body

You can modify any attribute of the user, except for userExtId.

For more information, see Create user.


Setting up or modifying a user's address

"address": {
"dwellingNumber": "31",
"city": "Budapest",
"street": "Corvin sétány",
"countryCode": "hu",
"postalCode": "1082",
"postOfficeBoxText": "133",
"houseNumber": "1/b",
"locality": "Corvin-negyed",
"addressline2": "Main building",
"addressline1": "Corvin sétány 1/b",
"postOfficeBoxNumber": 9

Setting up or modifying a user's custom attribute

"properties": {
"preferredContactChannel": "email"

Deleting a user's custom attribute

"properties": {
"preferredContactChannel": ""

You can only create or update value for a custom attribute that is already defined. Otherwise the request will fail. The custom attribute definition can be requested as a white glove service in Identity Cloud by an administrator.

HTTP response

On success

HTTP/1.1 200 is returned if the user is successfully modified.

The response contains all attributes of the user. The version and lastModified parameters are updated automatically.

For more information, see View user details.

On failure

HTTP/1.1 401 is returned if the authorization failed due to an invalid JWT.

HTTP/1.1 409 is returned if update failed with conflict.

HTTP/1.1 422 is returned if invalid request content was given.

HTTP/1.1 500 is returned if an unexpected error occurred.