PUT/user/{username}

Replace a user resource

Replaces the user resource identified by the supplied username with the provided user details. The body is optional, and none of its listed fields are marked as required. Only the authenticated user can perform this operation.

1 parameter · 8 body fields
usernamestringrequired
The name of the user resource to replace.

An optional user object containing the details to apply to the user resource.

idintegeroptional
The user's numeric identifier.
usernamestringoptional
The user's username.
firstNamestringoptional
The user's first name.
lastNamestringoptional
The user's last name.
emailstringoptional
The user's email address.
passwordstringoptional
The user's password.
phonestringoptional
The user's phone number.
userStatusintegeroptional
User Status

4 status codes
200Returns confirmation that the user resource was updated.
400Returned when the request is invalid.
404Returned when the user is not found.
defaultUnexpected error

Error handling

A 400 is returned for a bad request. A 404 is returned when no user is found for the supplied name. The username path parameter identifies the user resource to replace.