# addressbooks.import

Import addressbook data.

Imports multiple addressbook items in bulk from a text/vcard file (iCalendar .ics or vCard .vcf).

```ts
openemail.addressbooks.import(
  identityId: string,
  addressbookId: string,
  vcard: RawBody,
  options?: CallOptions,
): ApiPromise<PimImportResult>
```

It calls `POST /identities/{identityId}/addressbooks/{addressbookId}/import`: [Import addressbook data](/docs/api/pim/post_AddressbookImport) in the API reference.

## Example

```ts
const pimImportResult = await openemail.addressbooks.import(identityId, addressbookId, vcard)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Identity ULID identifier. The path's `{identityId}`. |
| `addressbookId` | `string` | Collection ULID or its name slug. The path's `{addressbookId}`. |
| `vcard` | [`RawBody`](/docs/sdks/typescript/calling-methods#raw-bodies) | vCard file contents (.vcf) with one or more VCARD components. The request's body, as bytes: text, a `Blob`, an `ArrayBuffer` or a `Uint8Array` ([raw bodies](/docs/sdks/typescript/calling-methods#raw-bodies)). |

## 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, [`PimImportResult`](/docs/sdks/typescript/types/pim-import-result). 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` | empty_body, not_calendar, or empty_import |
| `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 collection, or mailbox not accessible |
| `413` | import_too_large (max 16777216 bytes) or too_many_items (max 500 items) |
| `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

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