Company Onboarding
deleteBusinessUser
- Documentation
- API Reference
Company Onboarding
User Onboarding
Admin Portal
User Portal
Payroll
Reports
API Reference
Company Onboarding
deleteBusinessUser
This Endpoint is used to Delete the Business User
DELETE
/
companyOnboarding#deleteBusinessUser
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
deleteBusinessUser · string
*
method
Required
string
Add Example Value
businessUser
object
*
businessUser
Required
object
businessUserId
string
*
businessUserId
Required
string
curl --request DELETE \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#deleteBusinessUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "deleteBusinessUser",
"businessUser": {
"businessUserId": "77158402-ba31-496d-b0bb-02e2998b15f4"
}
}'
{
"1": {
"summary": "Success",
"value": {
"businessUser": {
"businessUserId": "77158402-ba31-496d-b0bb-02e2998b15f4",
"status": "Inactive",
"message": "The Business User has been deleted successfully."
}
}
}
}
Body
application/json
method
string
default: deleteBusinessUserrequiredbusinessUser
object
requiredbusinessUser.businessUserId
string
requiredResponse
200 - application/json
businessUser
object
requiredbusinessUser.businessUserId
string
requiredbusinessUser.status
string
requiredbusinessUser.message
string
curl --request DELETE \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#deleteBusinessUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "deleteBusinessUser",
"businessUser": {
"businessUserId": "77158402-ba31-496d-b0bb-02e2998b15f4"
}
}'
{
"1": {
"summary": "Success",
"value": {
"businessUser": {
"businessUserId": "77158402-ba31-496d-b0bb-02e2998b15f4",
"status": "Inactive",
"message": "The Business User has been deleted successfully."
}
}
}
}