Calendar

Delete appointment.

delete/api/v1/calendar

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Query parameters

idstring

appointment id

customMessagestring

ccancel message

sendNotificationboolean

send notification

doHardDeleteboolean

delete event

Headers

Authorizationstring

Authorization header.

X-Impersonate-Userstring

Impersonation header.

Response

OK

idstring

Id of appointment

instanceType'SingleInstance' | 'SeriesMaster' | 'Occurrence' required

Appointment instance type

providerType'GoogleCalendar' | 'MicrosoftCalendar' | 'ExchangeCalendar' required

Appointment provider type

subjectstring

Appointment subject

descriptionstring

Appointment description

descriptionContentTypestring

Appointment description content type

locationstring

Appointment location

startTimestring date-time

Appointment start time (is set to midnight if it is all day)

endTimestring date-time

Appointment end time (is set to midnight if it is all day)

timezonestring

Appointment timezone

startTimezonestring

Appointment start timezone (IANA) - falls back to Timezone

stopTimezonestring

Appointment end timezone (IANA) - falls back to StartTimezone, then Timezone

isAllDayboolean

Flag indicating whether the appointment is all day

isCancelledboolean

Flag indicating whether the appointment was canceled

masterIdstring

Reference to appointment recurring master if is one instance of recurring appointment

hasAttachmentboolean required

Has attachments

Changes

No recorded changes to this operation across all 1 revision of this API.