# addressbooks.create

Create addressbook.

Creates a new addressbook collection for a mailbox.

```ts
openemail.addressbooks.create(
  identityId: string,
  body: AddressbooksCreateBody,
  options?: CallOptions,
): ApiPromise<PimCollection>
```

It calls `POST /identities/{identityId}/addressbooks`: [Create addressbook](/docs/api/pim/post_AddressbookCreate) in the API reference.

## Example

```ts
const pimCollection = await openemail.addressbooks.create(identityId, { name: 'Ada' })
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Mailbox identity ULID. The path's `{identityId}`. |
| `body` | [`AddressbooksCreateBody`](#addressbookscreatebody) | 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, [`PimCollection`](/docs/sdks/typescript/types/pim-collection). 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, invalid_name, or invalid_components |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Mailbox not found or not accessible to this principal |
| `409` | name_taken, or too_many_collections (max 10) |
| `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

### AddressbooksCreateBody

```ts
/** The body of `addressbooks.create`. */
type AddressbooksCreateBody = {
  color?: string
  description?: string
  descriptionLang?: string | null
  displayName?: string
  /** URL slug: letters, digits, and . _ ~ - (the DAV path segment) */
  name: string
  role?: string | null
  /** Access visibility scope */
  visibility?: ('private' | 'shared' | 'public')
}
```

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