Calven

Submit time off updates

POST

/v1/timeoff

Time off

Submit time off updates to Calven.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

timeOffEvents

array[object (TimeOffEvent) {7}]

required

Time off events

eventId

string

required

Event ID

Example:

C5C69845-DD77-487E-9C6A-708581B361E9

string

optional

Employee’s email address - Required if uid is not present.

Example:

bob@domain.com

uid

string

optional

Employee’s Calven uid - Required if email is not present.

Example:

ABC123HGbghdhdI

eventType

string

required

The time off event type. One of 'scheduled' or 'cancelled'

Example:

scheduled

startDate

string

required

Start date of scheduled or cancelled leave in format yyyy-mm-dd

endDate

string

required

End date of scheduled or cancelled leave in format yyyy-mm-dd

timeOffType

string

optional

Type of time off. One of 'holiday', 'leave' or 'sick'

Example

{
    "timeOffEvents": [
        {
            "eventId": "C5C69845-DD77-487E-9C6A-708581B361E9",
            "email": "bob@domain.com",
            "eventType": "scheduled",
            "startDate": "2024-12-30",
            "endDate": "2025-01-02",
            "timeOffType": "leave"
        },
        {
            "eventId": "C5C69845-DD77-487E-9C6A-708581B361E9",
            "email": "mary@domain.com",
            "eventType": "cancelled",
            "startDate": "2024-11-30",
            "endDate": "2025-11-30"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.calven.com/v1/timeoff' \
--header 'Content-Type: application/json' \
--data-raw '{
    "timeOffEvents": [
        {
            "eventId": "C5C69845-DD77-487E-9C6A-708581B361E9",
            "email": "bob@domain.com",
            "eventType": "scheduled",
            "startDate": "2024-12-30",
            "endDate": "2025-01-02",
            "timeOffType": "leave"
        },
        {
            "eventId": "C5C69845-DD77-487E-9C6A-708581B361E9",
            "email": "mary@domain.com",
            "eventType": "cancelled",
            "startDate": "2024-11-30",
            "endDate": "2025-11-30"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

timestamp

string

required

Response timestamp

results

array[object (TimeoffEventResponse) {3}]

required

Time off event responses

eventId

string

required

Event ID

Example:

C5C69845-DD77-487E-9C6A-708581B361E9

resultCode

enum<number>

required

Result code

Allowed values:

0123

Example:

message

string

required

Message for this event result

Example

{
    "timestamp": "string",
    "results": [
        {
            "eventId": "C5C69845-DD77-487E-9C6A-708581B361E9",
            "resultCode": 0,
            "message": "string"
        }
    ]
}

🟢201Success

🟠401Payload when auth header is missing or invalid

🟠403403

Submit occupancy events

Submit access credentials