API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- POSTAddcompanybankaccount
- PUTDeactivateCompanyBankAccount
- POSTAddUser
- POSTAddBusinessContractor
- PUTUpdateUser
- POSTAddUsers
- POSTAddstateregistration
- PUTUpdatestateregistration
- POSTAddUserWage
- PUTUpdateUserWage
- PUTUpdateBusinessUserAsEmployee
- PUTUpdateEmployeeAsBusinessUser
- PUTUpdateBusinessUser
- PUTUpdatecompanylocation
- POSTActivateUser
- POSTDeactivateUser
- DELDeleteStateRegistration
- PUTTerminateUser
- StateRegistration
- POST
- User Portal
- Payroll
- Benefits
- Reports
- Webhooks
Admin Portal
DeactivateUser
POST
/
adminPortal#deactivateUser
curl --request POST \
--url 'https://sandbox.rollfi.xyz/adminPortal#deactivateUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "deactivateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"additionalNotes": "deactivating temporarily"
}
}'
{
"summary": "Success",
"value": {
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"status": "Inactive",
"message": "The User has been deactivated successfully."
}
}
}
Body
application/json
Example:
["deactivateUser"]
Maximum length:
10
Maximum length:
40
Available options:
They will be paid by cash or check
, They will be paid by supplemental payroll
, They will be paid by a different way
, They will be paid during a regular payroll cycle
, They have already been paid
Maximum length:
40
curl --request POST \
--url 'https://sandbox.rollfi.xyz/adminPortal#deactivateUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "deactivateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"additionalNotes": "deactivating temporarily"
}
}'
{
"summary": "Success",
"value": {
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"status": "Inactive",
"message": "The User has been deactivated successfully."
}
}
}