Create a time-off

post

https://api.rocketlane.com/api/1.0/time-offs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

includeFields

array of strings

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeFields

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Body Params

user

object

required

The time-off user.

note

string

The note or comment about the time-off.

startDate

string

required

The time-off start date. The format for the start date is YYYY-MM-DD.

endDate

string

required

The time-off end date. The endDate must be on or after the startDate, formatted as YYYY-MM-DD.

type

string

enum

required

The type of the time-off.

Allowed:

notifyUsers

object

Users to notify about your time off.

durationInMinutes

int32

≥ 1

The duration of time off is determined by the type selected: if the time off type is CUSTOM, the durationInMinutes field is required.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The resource was successfully created in the database.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.

500This error denotes that there is an error that occured within our servers. The response body could help narrow down the cause for the error by our support team.