deactivateUser
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/deactivateUser \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "deactivateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"additionalNotes": "deactivating temporarily"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/deactivateUser"
payload = {
"method": "deactivateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"additionalNotes": "deactivating temporarily"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'deactivateUser',
user: {
userId: 'f9b2507d-c757-4c9a-9e96-0002299fa2f7',
exitDate: '2023-09-09',
personalEmail: 'mm@aa.ll',
finalPayCheckType: 'They have already been paid',
additionalNotes: 'deactivating temporarily'
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/deactivateUser', 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/deactivateUser",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'deactivateUser',
'user' => [
'userId' => 'f9b2507d-c757-4c9a-9e96-0002299fa2f7',
'exitDate' => '2023-09-09',
'personalEmail' => 'mm@aa.ll',
'finalPayCheckType' => 'They have already been paid',
'additionalNotes' => 'deactivating temporarily'
]
]),
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/deactivateUser"
payload := strings.NewReader("{\n \"method\": \"deactivateUser\",\n \"user\": {\n \"userId\": \"f9b2507d-c757-4c9a-9e96-0002299fa2f7\",\n \"exitDate\": \"2023-09-09\",\n \"personalEmail\": \"mm@aa.ll\",\n \"finalPayCheckType\": \"They have already been paid\",\n \"additionalNotes\": \"deactivating temporarily\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.rollfi.xyz/adminPortal/deactivateUser")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"deactivateUser\",\n \"user\": {\n \"userId\": \"f9b2507d-c757-4c9a-9e96-0002299fa2f7\",\n \"exitDate\": \"2023-09-09\",\n \"personalEmail\": \"mm@aa.ll\",\n \"finalPayCheckType\": \"They have already been paid\",\n \"additionalNotes\": \"deactivating temporarily\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/deactivateUser")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"deactivateUser\",\n \"user\": {\n \"userId\": \"f9b2507d-c757-4c9a-9e96-0002299fa2f7\",\n \"exitDate\": \"2023-09-09\",\n \"personalEmail\": \"mm@aa.ll\",\n \"finalPayCheckType\": \"They have already been paid\",\n \"additionalNotes\": \"deactivating temporarily\"\n }\n}"
response = http.request(request)
puts response.read_body{
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"status": "Inactive",
"message": "The User has been deactivated successfully."
}
}{
"error": {
"code": 400,
"message": "EmployeeId is mandatory and cannot be empty."
}
}Admin Portal
deactivateUser
The deactivateUser API temporarily deactivates an employee or contractor.
What it does:
- Deactivates users while preserving their records for potential reactivation
- Sets exit date and final paycheck details for the deactivated user
- Triggers an automated email explaining the deactivation to the employee
- Allows additional notes to be recorded - circumstances or employee specific details on deactivation
Notes:
- Different from
terminateUser- deactivated users can be reactivated withactivateUser - Used for temporary separations like leave of absence or seasonal layoffs
POST
/
adminPortal
/
deactivateUser
deactivateUser
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/deactivateUser \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "deactivateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"additionalNotes": "deactivating temporarily"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/deactivateUser"
payload = {
"method": "deactivateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"additionalNotes": "deactivating temporarily"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'deactivateUser',
user: {
userId: 'f9b2507d-c757-4c9a-9e96-0002299fa2f7',
exitDate: '2023-09-09',
personalEmail: 'mm@aa.ll',
finalPayCheckType: 'They have already been paid',
additionalNotes: 'deactivating temporarily'
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/deactivateUser', 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/deactivateUser",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'deactivateUser',
'user' => [
'userId' => 'f9b2507d-c757-4c9a-9e96-0002299fa2f7',
'exitDate' => '2023-09-09',
'personalEmail' => 'mm@aa.ll',
'finalPayCheckType' => 'They have already been paid',
'additionalNotes' => 'deactivating temporarily'
]
]),
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/deactivateUser"
payload := strings.NewReader("{\n \"method\": \"deactivateUser\",\n \"user\": {\n \"userId\": \"f9b2507d-c757-4c9a-9e96-0002299fa2f7\",\n \"exitDate\": \"2023-09-09\",\n \"personalEmail\": \"mm@aa.ll\",\n \"finalPayCheckType\": \"They have already been paid\",\n \"additionalNotes\": \"deactivating temporarily\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.rollfi.xyz/adminPortal/deactivateUser")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"deactivateUser\",\n \"user\": {\n \"userId\": \"f9b2507d-c757-4c9a-9e96-0002299fa2f7\",\n \"exitDate\": \"2023-09-09\",\n \"personalEmail\": \"mm@aa.ll\",\n \"finalPayCheckType\": \"They have already been paid\",\n \"additionalNotes\": \"deactivating temporarily\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/deactivateUser")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"deactivateUser\",\n \"user\": {\n \"userId\": \"f9b2507d-c757-4c9a-9e96-0002299fa2f7\",\n \"exitDate\": \"2023-09-09\",\n \"personalEmail\": \"mm@aa.ll\",\n \"finalPayCheckType\": \"They have already been paid\",\n \"additionalNotes\": \"deactivating temporarily\"\n }\n}"
response = http.request(request)
puts response.read_body{
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"status": "Inactive",
"message": "The User has been deactivated successfully."
}
}{
"error": {
"code": 400,
"message": "EmployeeId is mandatory and cannot be empty."
}
}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
