Name | Description | Type | Additional information |
---|---|---|---|
account_name |
Optional - The account name where the user should be assigned. If null or blank, the account name associated with the API credentials will be used. If the account associated with the API credentials has access to child accounts, the child account name can be specified here. |
string |
None. |
action |
Optional - The action to perform on the user. Available options are: Upsert (default) and delete. Upsert will update the user if exists and insert the user if not exists. |
string |
None. |
send_announcement_email |
Optional - If true, an announcement email will be sent to the user (if new) with instructions on how to login. |
boolean |
None. |
username |
Required - The username of the new user account. |
string |
None. |
first_name |
Required - The first name of the user. |
string |
None. |
middle_name |
Required - The middle name of the user. |
string |
None. |
last_name |
Required - The last name of the user. |
string |
None. |
Required - The email address of the user. |
string |
None. |
|
phone_number |
Required - The primary phone number of the user. |
string |
None. |
mobile_phone |
Optional - The mobile phone number of the user. |
string |
None. |
fax |
Optional - The fax phone number of the user. |
string |
None. |
access_level_name |
Required - The access level name to assign the user (i.e. Case Manager, Physician 1, Call Agent, etc.) |
string |
None. |
gmt_offset |
Optional - The GMT Offset of the timezone for the user. (i.e. -5 for EST) If blank, defaults to the provider account setting. |
decimal number |
None. |
division_name |
Optional - The division name associated with the user. |
string |
None. |