CalendarEventActions

Override one occurrence of a calendar event.

Changed on

Creates a new independent one-off calendar event for the given properties from a full snapshot and suppresses that occurrence on the original event.<br>You must have this scope: 'calendar-events.manage'.<br>For fine-grained clients, you must have this permission: 'core.calendar_events.create'.

put/calendar/v0-nsfw/event-actions/{id}/occurrences/{occurrenceDate}

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/calendar/v0-nsfw/event-actions/{id}/occurrences/{occurrenceDate}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: calendar-events.manage, admin

Path parameters

idstring required

The id of the original calendar event.

occurrenceDatestring date required

The start date of the occurrence being overridden, in the property time zone.

Request body

titlestring required

The title of the calendar event.

descriptionstring nullable

The description of the calendar event.

fromstring date required

The first date the calendar event takes place.

tostring date required

The last date the calendar event takes place.

category'ConcertsAndMusic' | 'Sports' | 'ArtsAndEntertainment' | 'ConferencesAndBusiness' | 'CommunityAndLifestyle' | 'PublicHoliday' | 'SchoolHoliday' | 'Other' required

The category of the calendar event.

propertyIdsstring[] required

The ids of the properties whose occurrence is replaced.

Example request

{
  "title": "Oktoberfest — Munich, revised",
  "description": "Moved to the Theresienwiese annex",
  "from": "2026-09-26",
  "to": "2026-09-26",
  "category": "CommunityAndLifestyle",
  "propertyIds": [
    "MUC",
    "BER"
  ]
}

Response

Calendar event occurrence successfully overridden.

idstring required

The id of the calendar event.

titlestring required

The title of the calendar event.

descriptionstring nullable

The description of the calendar event.

fromstring date required

The first date the calendar event takes place.

tostring date required

The last date the calendar event takes place.

category'ConcertsAndMusic' | 'Sports' | 'ArtsAndEntertainment' | 'ConferencesAndBusiness' | 'CommunityAndLifestyle' | 'PublicHoliday' | 'SchoolHoliday' | 'Other' required

The category of the calendar event.

propertyIdsstring[] required

The ids of the properties this calendar event currently applies to. Sorted A–Z by property code.

Example response

{
  "id": "ZDGUUAKX",
  "title": "Oktoberfest",
  "description": "Munich's yearly beer festival",
  "from": "2026-09-19",
  "to": "2026-10-04",
  "category": "CommunityAndLifestyle",
  "propertyIds": [
    "MUC"
  ],
  "recurrence": {
    "frequency": "Yearly",
    "interval": 1
  }
}

Changes