Company Onboarding
deleteCompanyLocation
- Documentation
- API Reference
Company Onboarding
User Onboarding
Admin Portal
User Portal
Payroll
Reports
API Reference
Company Onboarding
deleteCompanyLocation
This Endpoint is used to delete the required Company Location
DELETE
/
companyOnboarding#deleteCompanyLocation
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
deleteCompanyLocation · string
*
method
Required
string
Add Example Value
companyLocation
object
*
companyLocation
Required
object
companyLocationId
string
*
companyLocationId
Required
string
curl --request DELETE \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#deleteCompanyLocation' \
--header 'Content-Type: application/json' \
--data '{
"method": "deleteCompanyLocation",
"companyLocation": {
"companyLocationId": "A4EA3BD6-2821-4F94-83A6-5C126991AB28"
}
}'
{
"1": {
"summary": "Success",
"value": {
"companyLocation": {
"companyLocationId": "A4EA3BD6-2821-4F94-83A6-5C126991AB28",
"status": "Inactive",
"message": "Company Location has been deleted successfully."
}
}
}
}
Body
application/json
method
string
default: deleteCompanyLocationrequiredcompanyLocation
object
requiredcompanyLocation.companyLocationId
string
requiredResponse
200 - application/json
companyLocation
object
requiredcompanyLocation.companyLocationId
string
requiredcompanyLocation.status
string
requiredcompanyLocation.message
string
curl --request DELETE \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#deleteCompanyLocation' \
--header 'Content-Type: application/json' \
--data '{
"method": "deleteCompanyLocation",
"companyLocation": {
"companyLocationId": "A4EA3BD6-2821-4F94-83A6-5C126991AB28"
}
}'
{
"1": {
"summary": "Success",
"value": {
"companyLocation": {
"companyLocationId": "A4EA3BD6-2821-4F94-83A6-5C126991AB28",
"status": "Inactive",
"message": "Company Location has been deleted successfully."
}
}
}
}