holiday_calendars
Holiday Calendars

Create Holiday Calendar

Changed on

Create Holiday Calendar

post/holiday_calendars

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/holiday_calendars
  • Auth
    none declared

Request body multipart/form-data

definitionobject required

Holiday rules for the calendar.

namestring required

Holiday Calendar name.

Example request

{
  "name": "Company Holidays"
}

Response

The HolidayCalendars object.

idinteger

Holiday Calendar ID. Set a scheduled resource's holiday_region to custom_ followed by this ID to make it skip the days in this calendar.

namestring

Holiday Calendar name.

definitionobject

Holiday rules for the calendar.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

{
  "id": 1,
  "name": "Company Holidays",
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Changes