Updates a user

Only properties that are not null will be updated

  • Email is required when ContactMethod is 'Email'
  • PhoneNumber is required when ContactMethod is 'PhoneNumber'
  • BusinessUnitAccess.Values should be a list of Business Unit Ids when BusinessUnitAccess.Type is 'SelectedBusinessUnits'
  • BusinessUnitAccess.Values should be null when BusinessUnitAccess.Type is 'AllBusinessUnits'
  • JobAccess.Values should be null when JobAccess.Type is 'AllJobs'

If updating a duplicate user with the Parent-Child feature, the following fields will also be updated in all duplicates:

  • Username
  • First Name
  • Last Name
  • Phone Number
  • Email
  • Contact Method
  • Allow Phone Number Login
  • Exclude From External Authentication

For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params

A model used for partial updates to a User

string | null

The unique username of the User, used to login to HCSS Apps.

string | null

The first name of the User.

string | null

The last name of the User.

string | null

The phone number of the User.

string | null

The email address of the User.

string
enum

Contact method for notifying the user

Allowed:
uuid | null

Assigns a Role to the User.

uuid | null

Assigns a Subscription Group to the User.

string | null

Used to add optional notes for the User.

uuid | null

The default Business Unit that the User belongs to.

string | null

Assigns an Employee to the User.

boolean | null

Enables the User to login to HCSS Apps using their phone number.

boolean | null

Excludes the User from signing in with external authentication and will require the User to use their HCSS Apps login.

businessUnitAccess
object

A model describing Business Unit Access. Combines the Type of access and list of Business Unit Guids.

jobAccess
object

A model describing Job Access. Combines the Type of access and list of Job Guids.
"SelectedJobTags" is not currently supported.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
204

User was successfully updated.

400

Bad Request. For help troubleshooting this error, visit https://developer.hcssapps.com/getting-started/troubleshoot-bad-request

403

Forbidden. For help troubleshooting this error, visit https://developer.hcssapps.com/getting-started/troubleshoot-forbidden

404

Existing user with id was not found. Verify that the id provided is correct.

Language
Credentials
OAuth2
Missing 3 required scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here!