Creates a new user

  • 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 creating a duplicate user with the Parent-Child feature, the following fields will all be synced from any existing duplicates:
        <ul><li>First Name</li><li>Last Name</li><li>Phone Number</li><li>Email</li><li>Contact Method</li><li>Allow Phone Number Login</li><li>Exclude From External Authentication</li></ul>
        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…
Body Params

A model used for creating a User

string
required

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

string
required

The first name of the User.

string
required

The last name of the User.

string | null

The phone number of the User.

string | null

The email address of the User.

string
enum
required

Contact method for notifying the user

Allowed:
uuid
required

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
required

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
201

User was successfully created.

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

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