addTimeOffRequest
curl --request POST \
--url https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addTimeOffRequest",
"timeOffRequest": {
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"employeeId": "1755E872-9092-4ECE-8386-860531D492D3",
"timeOffPolicyAssignmentId": "FB76A153-8358-4C2C-AD5A-60771C69EAD8",
"timeOffPolicyId": "1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A",
"requestHours": 12,
"requestStartDate": "2025-10-30",
"requestEndDate": "2025-11-04",
"timeOffLineItems": [
{
"date": "2025-10-30",
"requestHours": 4
},
{
"date": "2025-10-31",
"requestHours": 4
},
{
"date": "2025-11-02",
"requestHours": 2
},
{
"date": "2025-11-03",
"requestHours": 2
}
]
}
}
'import requests
url = "https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest"
payload = {
"method": "addTimeOffRequest",
"timeOffRequest": {
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"employeeId": "1755E872-9092-4ECE-8386-860531D492D3",
"timeOffPolicyAssignmentId": "FB76A153-8358-4C2C-AD5A-60771C69EAD8",
"timeOffPolicyId": "1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A",
"requestHours": 12,
"requestStartDate": "2025-10-30",
"requestEndDate": "2025-11-04",
"timeOffLineItems": [
{
"date": "2025-10-30",
"requestHours": 4
},
{
"date": "2025-10-31",
"requestHours": 4
},
{
"date": "2025-11-02",
"requestHours": 2
},
{
"date": "2025-11-03",
"requestHours": 2
}
]
}
}
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: 'addTimeOffRequest',
timeOffRequest: {
companyId: '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
employeeId: '1755E872-9092-4ECE-8386-860531D492D3',
timeOffPolicyAssignmentId: 'FB76A153-8358-4C2C-AD5A-60771C69EAD8',
timeOffPolicyId: '1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A',
requestHours: 12,
requestStartDate: '2025-10-30',
requestEndDate: '2025-11-04',
timeOffLineItems: [
{date: '2025-10-30', requestHours: 4},
{date: '2025-10-31', requestHours: 4},
{date: '2025-11-02', requestHours: 2},
{date: '2025-11-03', requestHours: 2}
]
}
})
};
fetch('https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest', 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/userPortal/addTimeOffRequest",
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' => 'addTimeOffRequest',
'timeOffRequest' => [
'companyId' => '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
'employeeId' => '1755E872-9092-4ECE-8386-860531D492D3',
'timeOffPolicyAssignmentId' => 'FB76A153-8358-4C2C-AD5A-60771C69EAD8',
'timeOffPolicyId' => '1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A',
'requestHours' => 12,
'requestStartDate' => '2025-10-30',
'requestEndDate' => '2025-11-04',
'timeOffLineItems' => [
[
'date' => '2025-10-30',
'requestHours' => 4
],
[
'date' => '2025-10-31',
'requestHours' => 4
],
[
'date' => '2025-11-02',
'requestHours' => 2
],
[
'date' => '2025-11-03',
'requestHours' => 2
]
]
]
]),
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/userPortal/addTimeOffRequest"
payload := strings.NewReader("{\n \"method\": \"addTimeOffRequest\",\n \"timeOffRequest\": {\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"employeeId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"timeOffPolicyAssignmentId\": \"FB76A153-8358-4C2C-AD5A-60771C69EAD8\",\n \"timeOffPolicyId\": \"1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A\",\n \"requestHours\": 12,\n \"requestStartDate\": \"2025-10-30\",\n \"requestEndDate\": \"2025-11-04\",\n \"timeOffLineItems\": [\n {\n \"date\": \"2025-10-30\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-10-31\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-11-02\",\n \"requestHours\": 2\n },\n {\n \"date\": \"2025-11-03\",\n \"requestHours\": 2\n }\n ]\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/userPortal/addTimeOffRequest")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addTimeOffRequest\",\n \"timeOffRequest\": {\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"employeeId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"timeOffPolicyAssignmentId\": \"FB76A153-8358-4C2C-AD5A-60771C69EAD8\",\n \"timeOffPolicyId\": \"1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A\",\n \"requestHours\": 12,\n \"requestStartDate\": \"2025-10-30\",\n \"requestEndDate\": \"2025-11-04\",\n \"timeOffLineItems\": [\n {\n \"date\": \"2025-10-30\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-10-31\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-11-02\",\n \"requestHours\": 2\n },\n {\n \"date\": \"2025-11-03\",\n \"requestHours\": 2\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest")
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\": \"addTimeOffRequest\",\n \"timeOffRequest\": {\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"employeeId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"timeOffPolicyAssignmentId\": \"FB76A153-8358-4C2C-AD5A-60771C69EAD8\",\n \"timeOffPolicyId\": \"1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A\",\n \"requestHours\": 12,\n \"requestStartDate\": \"2025-10-30\",\n \"requestEndDate\": \"2025-11-04\",\n \"timeOffLineItems\": [\n {\n \"date\": \"2025-10-30\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-10-31\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-11-02\",\n \"requestHours\": 2\n },\n {\n \"date\": \"2025-11-03\",\n \"requestHours\": 2\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"timeOffRequest": {
"timeOffRequestId": "4957449B-E7D7-4848-9D40-BCEB6CEA6595",
"status": "Pending",
"message": "Time off request created successfully"
}
}User Portal
addTimeOffRequest
The addTimeOffRequest API is used to create a new time off request for manager approval
Important:
- A user must be assigned to a time off policy, and be active in that policy (after affectiveStartDate) before they can submit a request.
- To add a user to a time off policy to make them request-eligible use the
addTimeOffPolicyAssignmentAPI
Notes:
- Users can determine when their time off hours are applied in between their PTO dates using timeOffLineItems
- timeOffLineItems must fall in between the dates specified and must sum to the total requestHours
- timeOffLineItems determine which PTO hours are added to each payperiod
- when a timeOffRequest is created it is “Pending”
POST
/
userPortal
/
addTimeOffRequest
addTimeOffRequest
curl --request POST \
--url https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addTimeOffRequest",
"timeOffRequest": {
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"employeeId": "1755E872-9092-4ECE-8386-860531D492D3",
"timeOffPolicyAssignmentId": "FB76A153-8358-4C2C-AD5A-60771C69EAD8",
"timeOffPolicyId": "1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A",
"requestHours": 12,
"requestStartDate": "2025-10-30",
"requestEndDate": "2025-11-04",
"timeOffLineItems": [
{
"date": "2025-10-30",
"requestHours": 4
},
{
"date": "2025-10-31",
"requestHours": 4
},
{
"date": "2025-11-02",
"requestHours": 2
},
{
"date": "2025-11-03",
"requestHours": 2
}
]
}
}
'import requests
url = "https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest"
payload = {
"method": "addTimeOffRequest",
"timeOffRequest": {
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"employeeId": "1755E872-9092-4ECE-8386-860531D492D3",
"timeOffPolicyAssignmentId": "FB76A153-8358-4C2C-AD5A-60771C69EAD8",
"timeOffPolicyId": "1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A",
"requestHours": 12,
"requestStartDate": "2025-10-30",
"requestEndDate": "2025-11-04",
"timeOffLineItems": [
{
"date": "2025-10-30",
"requestHours": 4
},
{
"date": "2025-10-31",
"requestHours": 4
},
{
"date": "2025-11-02",
"requestHours": 2
},
{
"date": "2025-11-03",
"requestHours": 2
}
]
}
}
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: 'addTimeOffRequest',
timeOffRequest: {
companyId: '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
employeeId: '1755E872-9092-4ECE-8386-860531D492D3',
timeOffPolicyAssignmentId: 'FB76A153-8358-4C2C-AD5A-60771C69EAD8',
timeOffPolicyId: '1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A',
requestHours: 12,
requestStartDate: '2025-10-30',
requestEndDate: '2025-11-04',
timeOffLineItems: [
{date: '2025-10-30', requestHours: 4},
{date: '2025-10-31', requestHours: 4},
{date: '2025-11-02', requestHours: 2},
{date: '2025-11-03', requestHours: 2}
]
}
})
};
fetch('https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest', 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/userPortal/addTimeOffRequest",
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' => 'addTimeOffRequest',
'timeOffRequest' => [
'companyId' => '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
'employeeId' => '1755E872-9092-4ECE-8386-860531D492D3',
'timeOffPolicyAssignmentId' => 'FB76A153-8358-4C2C-AD5A-60771C69EAD8',
'timeOffPolicyId' => '1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A',
'requestHours' => 12,
'requestStartDate' => '2025-10-30',
'requestEndDate' => '2025-11-04',
'timeOffLineItems' => [
[
'date' => '2025-10-30',
'requestHours' => 4
],
[
'date' => '2025-10-31',
'requestHours' => 4
],
[
'date' => '2025-11-02',
'requestHours' => 2
],
[
'date' => '2025-11-03',
'requestHours' => 2
]
]
]
]),
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/userPortal/addTimeOffRequest"
payload := strings.NewReader("{\n \"method\": \"addTimeOffRequest\",\n \"timeOffRequest\": {\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"employeeId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"timeOffPolicyAssignmentId\": \"FB76A153-8358-4C2C-AD5A-60771C69EAD8\",\n \"timeOffPolicyId\": \"1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A\",\n \"requestHours\": 12,\n \"requestStartDate\": \"2025-10-30\",\n \"requestEndDate\": \"2025-11-04\",\n \"timeOffLineItems\": [\n {\n \"date\": \"2025-10-30\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-10-31\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-11-02\",\n \"requestHours\": 2\n },\n {\n \"date\": \"2025-11-03\",\n \"requestHours\": 2\n }\n ]\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/userPortal/addTimeOffRequest")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addTimeOffRequest\",\n \"timeOffRequest\": {\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"employeeId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"timeOffPolicyAssignmentId\": \"FB76A153-8358-4C2C-AD5A-60771C69EAD8\",\n \"timeOffPolicyId\": \"1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A\",\n \"requestHours\": 12,\n \"requestStartDate\": \"2025-10-30\",\n \"requestEndDate\": \"2025-11-04\",\n \"timeOffLineItems\": [\n {\n \"date\": \"2025-10-30\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-10-31\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-11-02\",\n \"requestHours\": 2\n },\n {\n \"date\": \"2025-11-03\",\n \"requestHours\": 2\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/userPortal/addTimeOffRequest")
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\": \"addTimeOffRequest\",\n \"timeOffRequest\": {\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"employeeId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"timeOffPolicyAssignmentId\": \"FB76A153-8358-4C2C-AD5A-60771C69EAD8\",\n \"timeOffPolicyId\": \"1BD5AB2B-AEEC-46CD-A93B-D1A68FB90C3A\",\n \"requestHours\": 12,\n \"requestStartDate\": \"2025-10-30\",\n \"requestEndDate\": \"2025-11-04\",\n \"timeOffLineItems\": [\n {\n \"date\": \"2025-10-30\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-10-31\",\n \"requestHours\": 4\n },\n {\n \"date\": \"2025-11-02\",\n \"requestHours\": 2\n },\n {\n \"date\": \"2025-11-03\",\n \"requestHours\": 2\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"timeOffRequest": {
"timeOffRequestId": "4957449B-E7D7-4848-9D40-BCEB6CEA6595",
"status": "Pending",
"message": "Time off request created successfully"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
Show child attributes
Show child attributes
⌘I