Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Calendar Sync (iCal import)

Import a calendar

  To import external calendar events into Guesty Calendar via the iCalendar link,
  you must first create an imported-calendar entity. 
  This entity stores the import settings, such as the URL, calendar name, state, and events adjustment. 
  Once the entity is created, the import sync process will be initiated.
post/icalendar-api/imported-calendars

Request body

namestring required
urlstring required
listingIdstring required
adjustmentValueStart-2 | -1 | 0 | 1 | 2 required
adjustmentValueEnd-2 | -1 | 0 | 1 | 2 required

Response

Imported calendar created successfully

idstring required

Id of an imported calendar

listingIdstring required

Related listing id

accountIdstring required

Related account id

createdAtstring required

Time of creation of an imported calendar

updatedAtstring required

Time of last update of an imported calendar properties

status'active' | 'paused' | 'warning' | 'suspended' required

Status of an imported calendar

urlstring required

URL of an imported calendar

namestring required

Name of an imported calendar

lastSyncedAtstring

Timestamp of last successful sync of an imported calendar

adjustmentValueStartnumber required

Defines offset for start date of imported calendar events

adjustmentValueEndnumber required

Defines offset for end date of imported calendar events