PUT/user/{username}

Replace a user resource

Replaces the user resource identified by username with the supplied user data. Send the account fields in the request body to define the replacement; the schema does not mark any fields as required. The authenticated user can perform this operation.

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

User data for replacing the existing account. You can send the body as JSON, XML, or URL-encoded form data; no fields are marked as required.

idintegeroptional
The user's identifier.
usernamestringoptional
The username for the account.
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
200Confirms that the user resource was updated.
400Returned when the request is invalid.
404Returned when no user is found for the supplied username.
defaultUnexpected error

Error handling

A 400 is returned for a bad request. A 404 is returned when no user is found for the username path parameter; supply the username of an existing account.