# mailboxes.setRetention

Set retention window.

Sets this mailbox's OWN retention window in days — the owning account key or a system key; an app password may read the policy but not set it. Live messages older than it are expunged into the trash tier on the mailbox's next wake (restorable for 14 days; the trash purge frees storage after that), aged by the stored arrival time. Refused below the platform floor. Answers the same view as GET, including the preview of what the window will expunge — read it. To recover from a wrong window: clear or raise it FIRST, then restore; a message restored under the same window is due again at once.

```ts
openemail.mailboxes.setRetention(
  mailboxId: string,
  body: MailboxesSetRetentionBody,
  options?: CallOptions,
): ApiPromise<Retention>
```

It calls `PUT /mailboxes/{mailboxId}/retention`: [Set retention window](/docs/api/mailboxes/put_RetentionPut) in the API reference.

## Example

```ts
const retention = await openemail.mailboxes.setRetention(mailboxId, { retentionDays: 1 })
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |
| `body` | [`MailboxesSetRetentionBody`](#mailboxessetretentionbody) | The request's body. |

## 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, [`Retention`](/docs/sdks/typescript/types/retention). 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 |
| --- | --- |
| `400` | validation_failed, or retention_too_short (the window is below the platform floor; the body carries minDays) |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `403` | insufficient_scope (an app password may read this policy but not set it) |
| `404` | Mailbox not found or not accessible to this principal |
| `413` | too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing |
| `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

### MailboxesSetRetentionBody

```ts
/** The body of `mailboxes.setRetention`. */
type MailboxesSetRetentionBody = {
  /** The mailbox's own window in days. Refused below the platform floor (400 retention_too_short). Live messages older than it are expunged into the trash tier on the mailbox's next wake, restorable for 14 days */
  retentionDays: number
}
```

It names these types of the API, each on a page of its own: [`Retention`](/docs/sdks/typescript/types/retention).
