Updates the specified user by passing new values in the request body. Only Groupkey, Role, Type and Team Attributes fields can be updated.

🚧

Note

  • To update 'TeamAttributes', you must provide en entire list of team attributes and corresponding values. If you pass only attributes that you want to update, all other attributes, which are not provided, will be deleted.
  • To delete all attributes, pass TeamAttributes parameter with an empty array/hash.

The following are the examples of HTTP status codes including errors that API can generate

Response codesResponse contentDescription
200 OKA user has been updated successfully.
400 Bad RequestInvalid user type: "IncorrectType"The 'Type' parameter that was specified is invalid.
400 Bad RequestInvalid user role:"IncorrectRole"The 'Role' parameter that was specified is invalid.
400 Bad RequestClients is not availableYou need the 'Clients' feature to be enabled for your account to create a new client.
400 Bad RequestCanCreate is not available for admins'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default.
400 Bad RequestCanCreate is not available for clients'CanCreate' parameter is not allowed for users of type 'Client'. Clients have read only access.
400 Bad RequestIncorrect user TypeThe 'Type' parameter that was specified doesn't match the corresponding group UserType .
400 Bad RequestAttribute not found, Key=112A team attribute wasn't found.
403 ForbiddenAccess deniedYou can't update a user with 'Owner role.
404 Not FoundObject not foundA user with the specified key was not found.
Language
Authorization
Click Try It! to start a request and see the response here!