removeEmployeeBenefits

The removeEmployeeBenefits API removes an employee’s enrollment from specific benefit plans.

What it does:

• Removes employee enrollment from a specified company benefit plan

Supported Benefits:

• Medical
• Dental
• Vision

Note:

• Can only remove an employee from a benefit they have already been added to

POST /benefits#removeEmployeeBenefits

removeEmployeeBenefits

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/benefits#removeEmployeeBenefits' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "removeEmployeeBenefits",
  "benefitEmployeeElection": {
    "userId": "7B0AAA79-FDC5-4630-A10E-F9A87A35C780",
    "benefitType": "Medical",
    "effectiveMonth": "December 2024"
  }
}
'

200

{
  "Benefits": {
    "status": "Ready",
    "message": "The Benefits for Medical has been removed successfully.",
    "benefitType": "Medical"
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · default: addUserBankAccount · required

Example:

"addUserBankAccount"

benefitEmployeeElection · object · required

Show child attributes

Response

200

application/json

Benefits · object · required

Show child attributes