Skip to main content
POST
Skip an auto-claim on a date or period

Path Parameters

account-id
string<uuid>
required
schedule-id
string<uuid>
required

Body

application/json
date
string

Single day to skip (YYYY-MM-DD); shorthand for from=to

Example:

"2026-07-01"

from
string

Start of the skip window, inclusive (YYYY-MM-DD)

Example:

"2026-07-01"

to
string

End of the skip window, inclusive (YYYY-MM-DD)

Example:

"2026-07-15"

reason
string

Optional note recorded with the skip

Response

Skip window created

auto-claim-skip
object
required

The created skip window