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 addTimeOffPolicyAssignment API

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

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
      }
    ]
  }
}
'

200

1

{
  "timeOffRequest": {
    "timeOffRequestId": "4957449B-E7D7-4848-9D40-BCEB6CEA6595",
    "status": "Pending",
    "message": "Time off request created successfully"
  }
}

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 · required

timeOffRequest · object · required

Show child attributes

Response

200

application/json

timeOffRequest · object · required

Show child attributes