# sieve.renameScript

Rename a Sieve filter script.

Renames an existing Sieve script while preserving its active status.

```ts
openemail.sieve.renameScript(
  mailboxId: string,
  scriptName: string,
  body: SieveRenameScriptBody,
  options?: CallOptions,
): ApiPromise<SieveRenamed>
```

It calls `POST /mailboxes/{mailboxId}/sieve/scripts/{scriptName}/rename`: [Rename a Sieve filter script](/docs/api/filtering/post_SieveRename) in the API reference.

## Example

```ts
const sieveRenamed = await openemail.sieve.renameScript(mailboxId, scriptName, { newName: '…' })
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |
| `scriptName` | `string` | Sieve script name. The path's `{scriptName}`. |
| `body` | [`SieveRenameScriptBody`](#sieverenamescriptbody) | 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, [`SieveRenamed`](/docs/sdks/typescript/types/sieve-renamed). 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 — malformed name |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `403` | reserved — the new name is reserved for JSON rules |
| `404` | No such script, or mailbox not accessible |
| `409` | name_exists — a script with the new name already exists; or mailbox_is_group_persona (a group persona's archive runs no script) |
| `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

### SieveRenameScriptBody

```ts
/** The body of `sieve.renameScript`. */
type SieveRenameScriptBody = {
  /** New name for the script */
  newName: string
}
```

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