Skip to main content

Update User

Updates a user's display name. Only name and surname are editable here, and both are required: email and identity number identify the user and are set at creation or through a migration.

Required permission: user:update

Request​

PUT /v2/users/{user_id}

Parameters​

NameTypeInDescription
user_idstringpathRequired. User ID (24-character hex)

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>
Content-TypeRequired. application/json

Body​

FieldTypeRequiredDescription
namestringYesNew first name
surnamestringYesNew last name

Example​

curl --request PUT \
--url '{{baseUrl}}/v2/users/6a87455ad5f439809d488ac3' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "New Name",
"surname": "New Surname"
}'

Response​

Status Code: 200 OK, empty body.

Errors​

StatusCodeDescription
40010015Validation failed (name or surname missing) — see details
40010016user_id is not a valid id
40010001User not found (domain 1)

See Errors for the error format and common codes.