# schedulingInbox.consume

Consume a scheduling Inbox entry.

Acknowledges one Inbox entry: its message is dropped and it leaves the pending listing. The audit row stays. Owner-only. 404 when nothing is pending under that id.

```ts
openemail.schedulingInbox.consume(
  identityId: string,
  entryId: string,
  options?: CallOptions,
): ApiPromise<SchedulingInboxConsumeResult>
```

It calls `DELETE /identities/{identityId}/scheduling-inbox/{entryId}`: [Consume a scheduling Inbox entry](/docs/api/pim/delete_SchedulingInboxConsume) in the API reference.

## Example

```ts
const result = await openemail.schedulingInbox.consume(identityId, entryId)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Identity ULID identifier. The path's `{identityId}`. |
| `entryId` | `string` | Inbox entry ULID, from the listing. The path's `{entryId}`. |

## Options

It takes no options of its own. 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, [`SchedulingInboxConsumeResult`](#schedulinginboxconsumeresult). 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 |
| `404` | No such pending entry, or not this principal's identity |
| `503` | 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) |

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

### SchedulingInboxConsumeResult

```ts
/** What `schedulingInbox.consume` answers. */
type SchedulingInboxConsumeResult = {
  consumed: true
}
```
