Skip to content

Check-In and Check-Out Days

Endpoint Method Scope Description
/api/v1/listings/<id>/customizations/checkin-checkout-days/ GET listings:read Get check-in/check-out days customization for a listing
/api/v1/listings/<id>/customizations/checkin-checkout-days/ PATCH listings:write Update check-in/check-out days customization for a listing

Try it out

Explore schemas and live requests in the Swagger UI.

Part of Listing Customizations: its conventions and errors apply to every customization type.

Use checkin-checkout-days to restrict the weekdays guests may arrive and leave. Beyond pushes these rules to the listing's channel, so what you can set depends on that channel. The read-only channel-support object reports it for the listing's primary channel:

  • checkin-days: the channel accepts check-in days. When false, every PATCH to this customization returns 422.
  • checkout-days: the channel accepts check-out days separately. When false, Beyond may replace the check-out days you send with the check-in days.
  • seasonal-checkin-days / seasonal-checkout-days: the channel accepts date-specific days. When seasonal-checkin-days is false, seasonal-checkin-checkout-days accepts only [].
  • day-selection / seasonal-day-selection: single means each day list must be exactly one weekday or all seven; multi allows any set.
  • changeover-days-gap-fill: whether changeover-days-gap-fill-enabled may be set to true.

The payload includes:

  • checkin-days / checkout-days: the year-round weekdays. Send at least one weekday; all seven means no restriction.
  • seasonal-checkin-checkout-days: date ranges that override the year-round days. end-date is the last date the season applies. Set rollover to true to repeat the season every year on the same dates; the range must be shorter than one year, and its dates are then reported in the current year. A season lists a weekday in checkin-days, checkout-days, or both. Each of the two is one of:
    • a list of weekdays: only those weekdays are allowed during the season.
    • null (or omitted): the season keeps the year-round days for that side.
    • [] (only in a GET response): the season blocks every check-in (or checkout). Such seasons are set in the Beyond app; a PATCH that sends [] is rejected with 400.
  • changeover-days-gap-fill-enabled: whether orphan changeover gaps keep adjacent check-in/check-out rules active.
{
  "data": {
    "type": "checkin-checkout-day-customizations",
    "id": "123",
    "attributes": {
      "changeover-days-gap-fill-enabled": true,
      "checkin-days": ["friday", "saturday"],
      "checkout-days": ["monday", "sunday"],
      "seasonal-checkin-checkout-days": [
        {
          "start-date": "2026-11-01",
          "end-date": "2026-11-03",
          "checkin-days": ["saturday"],
          "checkout-days": ["saturday"],
          "rollover": false
        },
        {
          "start-date": "2026-12-20",
          "end-date": "2026-12-27",
          "checkin-days": ["sunday"],
          "checkout-days": ["sunday"],
          "rollover": true
        }
      ],
      "channel-support": {
        "checkin-days": true,
        "checkout-days": true,
        "seasonal-checkin-days": true,
        "seasonal-checkout-days": true,
        "day-selection": "multi",
        "seasonal-day-selection": "multi",
        "changeover-days-gap-fill": true
      }
    }
  }
}

PATCH changes only the fields you send; channel-support is ignored. seasonal-checkin-checkout-days, when sent, replaces the listing's whole list: include every season you want to keep, or send [] to remove them all. Weekdays are returned in calendar order, so a GET body can be sent back unchanged, unless a season blocks a side with []. A PATCH cannot recreate such a season: to keep it, leave seasonal-checkin-checkout-days out of the request.