updateEmployeeBenefits
curl --request PUT \
--url https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "updateEmployeeBenefits",
"benefitEmployeeElection": {
"userId": "1C58E147-2F3F-46C1-B6B7-098B6EA94993",
"benefitType": "Dental",
"effectiveMonth": "January 2025",
"companyContributionAmountPerPayPeriod": 75,
"employeeDeductionAmountPerPayPeriod": 25
}
}
'import requests
url = "https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits"
payload = {
"method": "updateEmployeeBenefits",
"benefitEmployeeElection": {
"userId": "1C58E147-2F3F-46C1-B6B7-098B6EA94993",
"benefitType": "Dental",
"effectiveMonth": "January 2025",
"companyContributionAmountPerPayPeriod": 75,
"employeeDeductionAmountPerPayPeriod": 25
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'updateEmployeeBenefits',
benefitEmployeeElection: {
userId: '1C58E147-2F3F-46C1-B6B7-098B6EA94993',
benefitType: 'Dental',
effectiveMonth: 'January 2025',
companyContributionAmountPerPayPeriod: 75,
employeeDeductionAmountPerPayPeriod: 25
}
})
};
fetch('https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'updateEmployeeBenefits',
'benefitEmployeeElection' => [
'userId' => '1C58E147-2F3F-46C1-B6B7-098B6EA94993',
'benefitType' => 'Dental',
'effectiveMonth' => 'January 2025',
'companyContributionAmountPerPayPeriod' => 75,
'employeeDeductionAmountPerPayPeriod' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits"
payload := strings.NewReader("{\n \"method\": \"updateEmployeeBenefits\",\n \"benefitEmployeeElection\": {\n \"userId\": \"1C58E147-2F3F-46C1-B6B7-098B6EA94993\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"January 2025\",\n \"companyContributionAmountPerPayPeriod\": 75,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"updateEmployeeBenefits\",\n \"benefitEmployeeElection\": {\n \"userId\": \"1C58E147-2F3F-46C1-B6B7-098B6EA94993\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"January 2025\",\n \"companyContributionAmountPerPayPeriod\": 75,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"updateEmployeeBenefits\",\n \"benefitEmployeeElection\": {\n \"userId\": \"1C58E147-2F3F-46C1-B6B7-098B6EA94993\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"January 2025\",\n \"companyContributionAmountPerPayPeriod\": 75,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"Benefits": {
"status": "Ready",
"message": "The Benefits for Dental has been updated successfully.",
"benefitType": "Dental"
}
}Benefits
updateEmployeeBenefits
The updateEmployeeBenefits API modifies an employee’s enrollment in specific benefit plans.
What it does:
- Updates employee enrollment details for a specified company benefit plan
- Modifies deduction amounts, company contributions, or coverage levels
Supported Benefits:
- Medical
- Dental
- Vision
Note:
- Can only update benefits for an employee who is already enrolled in the benefit plan
PUT
/
benefits
/
updateEmployeeBenefits
updateEmployeeBenefits
curl --request PUT \
--url https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "updateEmployeeBenefits",
"benefitEmployeeElection": {
"userId": "1C58E147-2F3F-46C1-B6B7-098B6EA94993",
"benefitType": "Dental",
"effectiveMonth": "January 2025",
"companyContributionAmountPerPayPeriod": 75,
"employeeDeductionAmountPerPayPeriod": 25
}
}
'import requests
url = "https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits"
payload = {
"method": "updateEmployeeBenefits",
"benefitEmployeeElection": {
"userId": "1C58E147-2F3F-46C1-B6B7-098B6EA94993",
"benefitType": "Dental",
"effectiveMonth": "January 2025",
"companyContributionAmountPerPayPeriod": 75,
"employeeDeductionAmountPerPayPeriod": 25
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'updateEmployeeBenefits',
benefitEmployeeElection: {
userId: '1C58E147-2F3F-46C1-B6B7-098B6EA94993',
benefitType: 'Dental',
effectiveMonth: 'January 2025',
companyContributionAmountPerPayPeriod: 75,
employeeDeductionAmountPerPayPeriod: 25
}
})
};
fetch('https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'updateEmployeeBenefits',
'benefitEmployeeElection' => [
'userId' => '1C58E147-2F3F-46C1-B6B7-098B6EA94993',
'benefitType' => 'Dental',
'effectiveMonth' => 'January 2025',
'companyContributionAmountPerPayPeriod' => 75,
'employeeDeductionAmountPerPayPeriod' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits"
payload := strings.NewReader("{\n \"method\": \"updateEmployeeBenefits\",\n \"benefitEmployeeElection\": {\n \"userId\": \"1C58E147-2F3F-46C1-B6B7-098B6EA94993\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"January 2025\",\n \"companyContributionAmountPerPayPeriod\": 75,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"updateEmployeeBenefits\",\n \"benefitEmployeeElection\": {\n \"userId\": \"1C58E147-2F3F-46C1-B6B7-098B6EA94993\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"January 2025\",\n \"companyContributionAmountPerPayPeriod\": 75,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/benefits/updateEmployeeBenefits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"updateEmployeeBenefits\",\n \"benefitEmployeeElection\": {\n \"userId\": \"1C58E147-2F3F-46C1-B6B7-098B6EA94993\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"January 2025\",\n \"companyContributionAmountPerPayPeriod\": 75,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"Benefits": {
"status": "Ready",
"message": "The Benefits for Dental has been updated successfully.",
"benefitType": "Dental"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
Show child attributes
Show child attributes
⌘I
