Skip to Content

Delete calendar object.

Deletes a calendar object by its href slug or UID. The object moves to the collection's trash (GET …/trash lists it, POST …/trash/{objectId}/restore brings it back) and is purged for good fourteen days later.

openemail.calendarObjects.delete(
  identityId: string,
  calendarId: string,
  href: string,
  options?: CalendarObjectsDeleteOptions,
): ApiPromise<CalendarObjectsDeleteResult>

It calls DELETE /identities/{identityId}/calendars/{calendarId}/objects/{href}: Delete calendar object in the API reference.

Example

const result = await openemail.calendarObjects.delete(identityId, calendarId, href)

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
calendarIdstringCollection ULID or its name slug. The path's {calendarId}.
hrefstringThe object's href: its filename segment within the collection (e.g. 1a2b3c.ics). The path's {href}.

Options

The last argument, options, a CalendarObjectsDeleteOptions, takes:

OptionTypeSent asDescription
uidstringquery uidMatch by UID instead of href
notifybooleanquery notifySend iTIP scheduling messages for this write: 'true' cancels as organizer or declines as attendee, 'false' sends nothing. Absent keeps the default — organizers schedule, attendees stay silent.
ifMatchstringheader if-matchTarget ETag validator
ifScheduleTagMatchstringheader if-schedule-tag-matchRFC 6638 §3.2.10.1 Schedule-Tag validator; validated independently of If-Match

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, CalendarObjectsDeleteResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403forbidden: read-only grant
404No such object, collection, or mailbox
412precondition_failed: If-Match not satisfied
503scheduling_unavailable: preparation could not complete; no deletion committed. Or temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)
507scheduling_backlog_full: scheduling admission budget exhausted; no deletion committed

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

CalendarObjectsDeleteResult

/** What `calendarObjects.delete` answers. */
type CalendarObjectsDeleteResult = {
  deleted: boolean
  href: string
  id: string
  syncToken: string
  uid: string
}