updateEmployeeAsBusinessUser
curl --request PUT \
--url https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "updateEmployeeAsBusinessUser",
"user": {
"userId": "8155F978-4A06-4BC7-937E-3AF761FC5F32",
"payrollAdmin": true,
"bookKeeper": true,
"beneficialOwner": true,
"ownershipPercentage": 30
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser"
payload = {
"method": "updateEmployeeAsBusinessUser",
"user": {
"userId": "8155F978-4A06-4BC7-937E-3AF761FC5F32",
"payrollAdmin": True,
"bookKeeper": True,
"beneficialOwner": True,
"ownershipPercentage": 30
}
}
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: 'updateEmployeeAsBusinessUser',
user: {
userId: '8155F978-4A06-4BC7-937E-3AF761FC5F32',
payrollAdmin: true,
bookKeeper: true,
beneficialOwner: true,
ownershipPercentage: 30
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser', 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/adminPortal/updateEmployeeAsBusinessUser",
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' => 'updateEmployeeAsBusinessUser',
'user' => [
'userId' => '8155F978-4A06-4BC7-937E-3AF761FC5F32',
'payrollAdmin' => true,
'bookKeeper' => true,
'beneficialOwner' => true,
'ownershipPercentage' => 30
]
]),
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/adminPortal/updateEmployeeAsBusinessUser"
payload := strings.NewReader("{\n \"method\": \"updateEmployeeAsBusinessUser\",\n \"user\": {\n \"userId\": \"8155F978-4A06-4BC7-937E-3AF761FC5F32\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 30\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/adminPortal/updateEmployeeAsBusinessUser")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"updateEmployeeAsBusinessUser\",\n \"user\": {\n \"userId\": \"8155F978-4A06-4BC7-937E-3AF761FC5F32\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 30\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser")
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\": \"updateEmployeeAsBusinessUser\",\n \"user\": {\n \"userId\": \"8155F978-4A06-4BC7-937E-3AF761FC5F32\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 30\n }\n}"
response = http.request(request)
puts response.read_body{
"user": {
"userId": "5A2390E1-0F83-46BD-AE1C-81B30FE364E1",
"status": "Ready",
"message": "The details of user William Henry were successfully updated."
}
}{
"error": {
"code": 400,
"message": "Invalid UserId"
}
}Admin Portal
updateEmployeeAsBusinessUser
The updateEmployeeAsBusinessUser API adds an existing employee as a Business User of the company.
What it does:
- Converts existing employees into Business Users with administrative roles
- Assigns roles like Payroll Admin, Controller, or Beneficial Owner to employees
Note:
- Requires ownership percentage specification for Beneficial Owner role
PUT
/
adminPortal
/
updateEmployeeAsBusinessUser
updateEmployeeAsBusinessUser
curl --request PUT \
--url https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "updateEmployeeAsBusinessUser",
"user": {
"userId": "8155F978-4A06-4BC7-937E-3AF761FC5F32",
"payrollAdmin": true,
"bookKeeper": true,
"beneficialOwner": true,
"ownershipPercentage": 30
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser"
payload = {
"method": "updateEmployeeAsBusinessUser",
"user": {
"userId": "8155F978-4A06-4BC7-937E-3AF761FC5F32",
"payrollAdmin": True,
"bookKeeper": True,
"beneficialOwner": True,
"ownershipPercentage": 30
}
}
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: 'updateEmployeeAsBusinessUser',
user: {
userId: '8155F978-4A06-4BC7-937E-3AF761FC5F32',
payrollAdmin: true,
bookKeeper: true,
beneficialOwner: true,
ownershipPercentage: 30
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser', 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/adminPortal/updateEmployeeAsBusinessUser",
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' => 'updateEmployeeAsBusinessUser',
'user' => [
'userId' => '8155F978-4A06-4BC7-937E-3AF761FC5F32',
'payrollAdmin' => true,
'bookKeeper' => true,
'beneficialOwner' => true,
'ownershipPercentage' => 30
]
]),
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/adminPortal/updateEmployeeAsBusinessUser"
payload := strings.NewReader("{\n \"method\": \"updateEmployeeAsBusinessUser\",\n \"user\": {\n \"userId\": \"8155F978-4A06-4BC7-937E-3AF761FC5F32\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 30\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/adminPortal/updateEmployeeAsBusinessUser")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"updateEmployeeAsBusinessUser\",\n \"user\": {\n \"userId\": \"8155F978-4A06-4BC7-937E-3AF761FC5F32\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 30\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/updateEmployeeAsBusinessUser")
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\": \"updateEmployeeAsBusinessUser\",\n \"user\": {\n \"userId\": \"8155F978-4A06-4BC7-937E-3AF761FC5F32\",\n \"payrollAdmin\": true,\n \"bookKeeper\": true,\n \"beneficialOwner\": true,\n \"ownershipPercentage\": 30\n }\n}"
response = http.request(request)
puts response.read_body{
"user": {
"userId": "5A2390E1-0F83-46BD-AE1C-81B30FE364E1",
"status": "Ready",
"message": "The details of user William Henry were successfully updated."
}
}{
"error": {
"code": 400,
"message": "Invalid UserId"
}
}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
