Periods of unavailability cannot overlap with employment dates and cannot overlap with existing periods of unavailability.
NOTE: If you do not have Private Write permissions, you cannot create private periods of unavailability.
Deprecated: The Unavailability rangeType is deprecated on this endpoint. Use the V2 /unavailabilities endpoint with createBackfillRoleIds for backfill functionality, or use the TimeOff rangeType for unavailability without backfill.
Permissions
Private: Write
Person: Read
HourlyProfile: Read
Unavailabilities: Write
HourlyUnavailabilities: Write
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Deprecation Notice — effective September 15, 2026
POST /v1/unavailabilitiesnow rejectsrangeType: 2(Unavailability).rangeType: 3(TimeOff) is unaffected.
What breaks
Any request to POST /v1/unavailabilities with rangeType: 2 will receive:
Status: 400 Bad Request
{
"error": "The Unavailability type is deprecated. Use V2 /unavailabilities endpoint with createBackfillRoleIds for backfill functionality, or use TimeOff type for unavailability without backfill."
}What to do
Switch to POST /v2/unavailabilities and pass backfill role IDs explicitly:
{
"rangeType": 2,
"startDate": "2025-10-01",
"endDate": "2025-10-05",
"createBackfillRoleIds": ["role-id-1", "role-id-2"]
}Questions? Contact [email protected].
Bad Request: Example when start and end date are outside employment dates
{
Example when start and end dates overlap with each other
{
Unauthorized
Forbidden