# polymorfa customer

> Manage project Customers, pairing links, and assigned Numbers.

## Commands

- [polymorfa customer archive](https://docs.polymorfa.com/cli/customer/archive): Archive a non-default Customer.
- [polymorfa customer create](https://docs.polymorfa.com/cli/customer/create): Create a Customer.
- [polymorfa customer enable](https://docs.polymorfa.com/cli/customer/enable): Enable Customers and assign existing Numbers to the default Customer.
- [polymorfa customer event list](https://docs.polymorfa.com/cli/customer/event-list): List recent events for a Customer.
- [polymorfa customer list](https://docs.polymorfa.com/cli/customer/list): List Customers in one project.
- [polymorfa customer number list](https://docs.polymorfa.com/cli/customer/number-list): List Numbers assigned to a Customer.
- [polymorfa customer number transfer](https://docs.polymorfa.com/cli/customer/number-transfer): Transfer a Number between Customers.
- [polymorfa customer pairing-link create](https://docs.polymorfa.com/cli/customer/pairing-link-create): Create a Customer pairing link.
- [polymorfa customer pairing-link list](https://docs.polymorfa.com/cli/customer/pairing-link-list): List pairing links for a Customer.
- [polymorfa customer pairing-link revoke](https://docs.polymorfa.com/cli/customer/pairing-link-revoke): Revoke an active Customer pairing link.
- [polymorfa customer restore](https://docs.polymorfa.com/cli/customer/restore): Restore an archived Customer.
- [polymorfa customer status](https://docs.polymorfa.com/cli/customer/status): Check whether Customers is enabled for a project.
- [polymorfa customer update](https://docs.polymorfa.com/cli/customer/update): Update Customer profile fields.
- [polymorfa customer view](https://docs.polymorfa.com/cli/customer/view): View one Customer.

## polymorfa customer archive

Archive a non-default Customer.

### Usage

```bash
polymorfa customer archive CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

- `--idempotency-key <value>` (value, required). Identify this archive attempt for safe retries.
- `--yes` (boolean, required). Confirm Customer archival.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer create

Create a Customer.

### Usage

```bash
polymorfa customer create [flags]
```

### Flags

- `--external-id <value>` (value). Caller-defined Customer ID.
- `--idempotency-key <value>` (value, required). Identify this create attempt for safe retries.
- `--name <value>` (value). Customer name.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer enable

Enable Customers and assign existing Numbers to the default Customer.

### Usage

```bash
polymorfa customer enable [flags]
```

### Flags

- `--idempotency-key <value>` (value, required). Identify this enablement attempt for safe retries.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer event list

List recent events for a Customer.

### Usage

```bash
polymorfa customer event list CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

- `--limit <value>` (value). Maximum events to return.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer list

List Customers in one project.

### Usage

```bash
polymorfa customer list [flags]
```

### Flags

- `--cursor <value>` (value). Continue from this cursor.
- `--default <value>` (value). Filter by default-Customer status. Values: `true`, `false`.
- `--has-numbers <value>` (value). Filter by whether a Customer has assigned Numbers. Values: `true`, `false`.
- `--limit <value>` (value). Maximum Customers to return.
- `--needs-attention <value>` (value). Filter by whether a Customer needs attention. Values: `true`, `false`.
- `--search <value>` (value). Search Customer profile fields.
- `--status <value>` (value). Filter by Customer status. Values: `active`, `archiving`, `archived`, `all`.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer number list

List Numbers assigned to a Customer.

### Usage

```bash
polymorfa customer number list CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer number transfer

Transfer a Number between Customers.

### Usage

```bash
polymorfa customer number transfer CUSTOMER SESSION [flags]
```

### Arguments

- `CUSTOMER` (required). Destination Customer ID.
- `SESSION` (required). Number session ID or slug.

### Flags

- `--from <value>` (value, required). Source Customer ID.
- `--idempotency-key <value>` (value, required). Identify this transfer attempt for safe retries.
- `--yes` (boolean, required). Confirm the Number transfer.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer pairing-link create

Create a Customer pairing link.

### Usage

```bash
polymorfa customer pairing-link create CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

- `--expected-phone <value>` (value). Expected phone number in E.164 format.
- `--expires-in <value>` (value). Link lifetime in seconds.
- `--idempotency-key <value>` (value, required). Identify this pairing-link attempt for safe retries.
- `--method <value>` (value, repeatable). Allowed pairing method. Values: `qr`, `phone`.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer pairing-link list

List pairing links for a Customer.

### Usage

```bash
polymorfa customer pairing-link list CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer pairing-link revoke

Revoke an active Customer pairing link.

### Usage

```bash
polymorfa customer pairing-link revoke CUSTOMER LINK [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.
- `LINK` (required). Pairing-link ID.

### Flags

- `--yes` (boolean, required). Confirm pairing-link revocation.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer restore

Restore an archived Customer.

### Usage

```bash
polymorfa customer restore CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

- `--idempotency-key <value>` (value, required). Identify this restore attempt for safe retries.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer status

Check whether Customers is enabled for a project.

### Usage

```bash
polymorfa customer status [flags]
```

### Flags

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer update

Update Customer profile fields.

### Usage

```bash
polymorfa customer update CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

- `--clear-external-id` (boolean). Clear the caller-defined Customer ID.
- `--clear-name` (boolean). Clear the Customer name.
- `--external-id <value>` (value). New caller-defined Customer ID.
- `--name <value>` (value). New Customer name.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa customer view

View one Customer.

### Usage

```bash
polymorfa customer view CUSTOMER [flags]
```

### Arguments

- `CUSTOMER` (required). Customer ID.

### Flags

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).
