Create Holiday
Create a new holiday
Headers
xi-api-key
xi-workspace-id
The customer workspace a reseller's API key acts on.
Request
This endpoint expects an object.
name
Display name of the closure or time off.
start_date
First day of the closure or time off, inclusive.
end_date
Last day of the closure or time off, inclusive.
time_off_type
What the entry applies to: a location, a staff member, or an asset.
Allowed values:
holiday_type
‘closed’ for no availability, or ‘override’ to use override_hours instead of the regular hours.
Allowed values:
override_hours
Replacement working hours when holiday_type is ‘override’.
resource_id
The staff member or asset ID; required when time_off_type is ‘staff’ or ‘asset’.
location_id
For LOCATION type: the location this closure applies to.
reason
Optional note on why the closure or time off happens, up to 500 characters.
Response
Successful Response
name
Display name of the closure or time off.
start_date
First day of the closure or time off, inclusive.
end_date
Last day of the closure or time off, inclusive.
time_off_type
What the entry applies to: a location, a staff member, or an asset.
Allowed values:
id
The closure or time-off entry’s ID.
created_at_unix
When the entry was created, as a Unix timestamp in seconds.
updated_at_unix
When the entry was last updated, as a Unix timestamp in seconds.
holiday_type
‘closed’ for no availability, or ‘override’ to use override_hours instead of the regular hours.
Allowed values:
override_hours
Replacement working hours when holiday_type is ‘override’.
resource_id
The staff member or asset ID; required when time_off_type is ‘staff’ or ‘asset’.
location_id
For LOCATION type: the location this closure applies to.
reason
Optional note on why the closure or time off happens, up to 500 characters.
Errors
422
Unprocessable Entity Error