Skip to navigation

Create a schedule override

Create a schedule override for a human. Overrides modify availability beyond the base schedule.

Block overrides remove availability:

  • All-day blocks for vacations or holidays
  • Time-specific blocks for recurring meetings or focus time

Open overrides add extra availability:

  • Weekend or evening hours for overtime
  • Special event availability outside normal schedule

Overrides support date ranges (start_date to end_date) and recurring patterns via the recurrence field.

Authentication

AuthorizationBearer

API key authentication. Pass your key as a Bearer token:

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx

Get your API key from the Slotflow Dashboard.

Path parameters

humanIdstringRequiredformat: "uuid"
The ID of the human

Request

This endpoint expects an object.
typeenumRequired

block to remove availability, open to add extra availability

Allowed values:
titlestringRequired
Descriptive label for this override
all_daybooleanRequired

Set to true for full-day overrides. When false, start_time and end_time are required.

start_datedateRequired

Start date (YYYY-MM-DD)

end_datedateOptional

End date for multi-day overrides (YYYY-MM-DD). Optional.

start_timestringOptionalformat: "^\d{2}:\d{2}$"

Required when all_day is false. HH:MM format in human’s timezone.

end_timestringOptionalformat: "^\d{2}:\d{2}$"

Required when all_day is false. HH:MM format in human’s timezone.

recurrenceobjectOptional

Defines a recurring pattern for schedule overrides. Null for one-time overrides.

Response

Override created
idstringOptionalformat: "uuid"
human_idstringOptionalformat: "uuid"
typeenumOptional

block removes availability, open adds extra availability

Allowed values:
titlestringOptional

Descriptive label (e.g. “Holiday break”, “Saturday overtime”)

all_daybooleanOptional
Whether this override applies to the entire day
start_datedateOptional

Start date (YYYY-MM-DD)

end_datedate or nullOptional

End date for multi-day overrides (YYYY-MM-DD). Null for single-day.

start_timestring or nullOptionalformat: "^\d{2}:\d{2}$"

Start time in HH:MM format. Null when all_day is true.

end_timestring or nullOptionalformat: "^\d{2}:\d{2}$"

End time in HH:MM format. Null when all_day is true.

recurrenceobjectOptional

Defines a recurring pattern for schedule overrides. Null for one-time overrides.

created_atdatetimeOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error