Admin Portal
updateBusinessUser
- Documentation
- API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- POSTaddCompanyBankAccount
- PUTdeactivateCompanyBankAccount
- POSTaddUser
- PUTupdateUser
- POSTaddUsers
- POSTaddStateRegistration
- PUTupdateStateRegistration
- POSTaddUserWage
- PUTupdateUserWage
- PUTupdateBusinessUserAsEmployee
- PUTupdateEmployeeAsBusinessUser
- PUTupdateBusinessUser
- PUTupdateCompanyLocation
- POSTactivateUser
- POSTdeactivateUser
- PUTterminateUser
- POST
- User Portal
- Payroll
- Reports
API Reference
Admin Portal
updateBusinessUser
The Business User details can be updated using this endpoint
PUT
/
adminPortal#updateBusinessUser
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
username
string
username
string
password
string
password
string
object
method
updateBusinessUser · string
*
method
Required
string
Add Example Value
businessUser
object
*
businessUser
Required
object
businessUserId
string
*
businessUserId
Required
string
firstName
string
firstName
string
middleName
string
middleName
string
lastName
string
lastName
string
phoneNumber
Must be 10 Digits · string
phoneNumber
string
Add Example Value
email
string
email
string
address1
string
address1
string
address2
string
address2
string
city
string
city
string
state
Enum · enum<string>
state
enum<string>
zipcode
Must be Five or Nine Digits · string
zipcode
string
country
enum<string>
country
enum<string>
ssn
string
ssn
string
Add Example Value
payrollAdmin
boolean
payrollAdmin
boolean
bookkeeper
boolean
bookkeeper
boolean
beneficialOwner
boolean
beneficialOwner
boolean
isEmployee
boolean
isEmployee
boolean
Body
application/json
method
string
default: updateBusinessUserrequiredbusinessUser
object
requiredbusinessUser.businessUserId
string
requiredbusinessUser.firstName
string
businessUser.middleName
string
businessUser.lastName
string
businessUser.phoneNumber
string
businessUser.email
string
businessUser.address1
string
businessUser.address2
string
businessUser.city
string
businessUser.state
enum<string>
Available options:
TX
, AK
, ND
, IL
, MA
, KS
, AS
, AL
, UT
, SD
, MI
, DC
, GA
, SC
, TN
, OK
, CO
, CA
, ME
, MO
, WY
, MD
, VT
, NM
, CT
, AZ
, WI
, VA
, WV
, NJ
, DE
, NC
, PR
, IN
, MT
, NH
, HI
, IA
, KY
, WA
, OH
, FL
, OR
, MP
, GU
, MN
, MS
, PA
, NE
, RI
, ID
, LA
, NY
, NV
, AR
businessUser.zipcode
string
businessUser.country
enum<string>
Available options:
US
businessUser.ssn
string
businessUser.payrollAdmin
boolean
businessUser.bookkeeper
boolean
businessUser.beneficialOwner
boolean
businessUser.isEmployee
boolean
Response
200 - application/json
businessUser
object
requiredbusinessUser.businessUserId
string
requiredbusinessUser.status
string
requiredbusinessUser.message
string