APapaleo
RatePlanActions

Attach a schedule to a rate plan with a cancellation policy.

Creates or updates the attachment for the given rate plan and schedule. A repeat call with the same rate plan and schedule repoints the cancellation policy. Rejected when the schedule range is entirely in the past (property-local today). Overlapping policy-bearing schedules on the same rate plan are rejected.<br>You must have this scope: 'setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.rate_plans.modify'.

put/rateplan/v0-nsfw/rate-plan-actions/{id}/schedules/{scheduleId}

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/rate-plan-actions/{id}/schedules/{scheduleId}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: setup.manage, admin

Path parameters

idstring required

The id of the rate plan.

scheduleIdstring required

The id of the schedule.

Request body

cancellationPolicyIdstring required

The id of the cancellation policy that applies to the rate plan over the schedule period

Example request

{
  "cancellationPolicyId": "MUC-STRICT"
}

Response

Attachment successfully created or updated.

ratePlanIdstring required

The rate plan id

scheduleIdstring required

The schedule id

Example response

{
  "ratePlanId": "MUC-FLEX",
  "scheduleId": "MUC-WIESN2026",
  "cancellationPolicy": {
    "id": "MUC-STRICT"
  }
}

Changes

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