APapaleo
CalendarEvent

Create a calendar event.

Create a new calendar event.<br>You must have this scope: 'calendar-events.manage'.<br>For fine-grained clients, you must have this permission: 'core.calendar_events.create'.

post/calendar/v0-nsfw/events

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/events
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: calendar-events.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

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 applies to.

Example request

{
  "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
  }
}

Response

Calendar event successfully created.

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

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