Schedule

Create a schedule.

Create a reusable schedule. Rejected when the range is entirely in the past (property-local today).<br>You must have at least one of these scopes: 'settings.manage, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.schedules.create'.

post/rateplan/v0-nsfw/schedules

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/rateplan/v0-nsfw/schedules
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.manage, setup.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

codestring required

The code for the schedule, used to assemble its id

namestring required

The name for the schedule

propertyIdstring required

The id of the property where the schedule will be created

validFromstring date required

The first arrival date the schedule applies to, inclusive, interpreted in the property time zone

validTostring date required

The last arrival date the schedule applies to, inclusive, interpreted in the property time zone

Example request

{
  "code": "WIESN2026",
  "name": "Oktoberfest 2026",
  "propertyId": "MUC",
  "validFrom": "2026-09-20",
  "validTo": "2026-10-05"
}

Response

Schedule successfully created.

idstring required

The schedule ID

Example response

{
  "id": "MUC-WIESN2026"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.