# calendarObjects.delete

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.

```ts
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](/docs/api/pim/delete_CalendarObjectDelete) in the API reference.

## Example

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

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Mailbox identity ULID. The path's `{identityId}`. |
| `calendarId` | `string` | Collection ULID or its name slug. The path's `{calendarId}`. |
| `href` | `string` | The 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:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `uid` | `string` | query `uid` | Match by UID instead of href |
| `notify` | `boolean` | query `notify` | Send 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. |
| `ifMatch` | `string` | header `if-match` | Target ETag validator |
| `ifScheduleTagMatch` | `string` | header `if-schedule-tag-match` | RFC 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](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`CalendarObjectsDeleteResult`](#calendarobjectsdeleteresult). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `403` | forbidden: read-only grant |
| `404` | No such object, collection, or mailbox |
| `412` | precondition_failed: If-Match not satisfied |
| `503` | scheduling_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) |
| `507` | scheduling_backlog_full: scheduling admission budget exhausted; no deletion committed |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

### CalendarObjectsDeleteResult

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