# polymorfa session

> Manage Platform sessions.

## Commands

- [polymorfa session capabilities](https://docs.polymorfa.com/cli/session/capabilities): Show the WhatsApp features and limits WhatsApp has enabled for a number, as of the number's last configuration sync. Beta: the team must be enrolled.
- [polymorfa session configuration get](https://docs.polymorfa.com/cli/session/configuration-get): Read effective session configuration, inheritance sources and revisions.
- [polymorfa session configuration update](https://docs.polymorfa.com/cli/session/configuration-update): Set configuration overrides or reset them to inherited defaults using a revision.
- [polymorfa session delete](https://docs.polymorfa.com/cli/session/delete): Permanently remove matching sessions from management.
- [polymorfa session hybrid-merge-candidates](https://docs.polymorfa.com/cli/session/hybrid-merge-candidates): List same-number Number pairs that can merge into one Hybrid Link Number.
- [polymorfa session list](https://docs.polymorfa.com/cli/session/list): List session metadata for the team or one project. Requires a team API key with sessions:read.
- [polymorfa session status](https://docs.polymorfa.com/cli/session/status): Read the stored session status and reason. Requires a team API key with sessions:read.
- [polymorfa session stop](https://docs.polymorfa.com/cli/session/stop): Request asynchronous stops for matching managed sessions.
- [polymorfa session tier confirm](https://docs.polymorfa.com/cli/session/tier-confirm): Confirm a reviewed Number tier quote.
- [polymorfa session tier quote](https://docs.polymorfa.com/cli/session/tier-quote): Preview a Number tier change without changing the Number or spending credit.
- [polymorfa session tier status](https://docs.polymorfa.com/cli/session/tier-status): Read a Number tier change and its Hybrid Link transition.
- [polymorfa session view](https://docs.polymorfa.com/cli/session/view): Read one session by its ID. Requires a team API key with sessions:read.

## polymorfa session capabilities

Show the WhatsApp features and limits WhatsApp has enabled for a number, as of the number's last configuration sync. Beta: the team must be enrolled.

### Usage

```bash
polymorfa session capabilities SESSION [flags]
```

### Arguments

- `SESSION` (required). Session ID or name.

### Flags

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

### Examples

```bash
polymorfa session capabilities support-line
```

```bash
polymorfa session capabilities support-line --json
```

## polymorfa session configuration get

Read effective session configuration, inheritance sources and revisions.

### Usage

```bash
polymorfa session configuration get SESSION [flags]
```

### Arguments

- `SESSION` (required). Session ID.

### Flags

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

## polymorfa session configuration update

Set configuration overrides or reset them to inherited defaults using a revision.

### Usage

```bash
polymorfa session configuration update SESSION [flags]
```

### Arguments

- `SESSION` (required). Session ID.

### Flags

- `--input <value>` (value, required). JSON file or stdin (-), containing revision and configuration.set/reset.

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

## polymorfa session delete

Permanently remove matching sessions from management.

### Usage

```bash
polymorfa session delete SESSIONS [flags]
```

### Arguments

- `SESSIONS` (required). One to 100 session UUIDs or stable slugs.

### Flags

- `--idempotency-key <value>` (value). Identify this attempt (a retry counts only rows still present).
- `--yes` (boolean, required). Confirm permanent removal of every supplied session.

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

## polymorfa session hybrid-merge-candidates

List same-number Number pairs that can merge into one Hybrid Link Number.

List same-number Number pairs that can merge into one Hybrid Link Number.

Each pair is one Linked Devices Number and one Official API Number that shares the number with the WhatsApp Business app. Merge an eligible pair with `session tier quote KEEP_UUID --tier pro --merge-with OTHER_UUID`. A Number marked "must be kept" uses hosted message storage and cannot be the one merged away. Requires Hybrid Link access.

### Usage

```bash
polymorfa session hybrid-merge-candidates [flags]
```

### Flags

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

### Examples

```bash
polymorfa session hybrid-merge-candidates --project PROJECT_UUID
```

## polymorfa session list

List session metadata for the team or one project. Requires a team API key with sessions:read.

### Usage

```bash
polymorfa session list [flags]
```

### Flags

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

### Examples

```bash
polymorfa session list
```

```bash
polymorfa session list --project PROJECT_ID --json
```

## polymorfa session status

Read the stored session status and reason. Requires a team API key with sessions:read.

### Usage

```bash
polymorfa session status SESSION [flags]
```

### Arguments

- `SESSION` (required). Session ID.

### Flags

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

### Examples

```bash
polymorfa session status SESSION_ID
```

## polymorfa session stop

Request asynchronous stops for matching managed sessions.

### Usage

```bash
polymorfa session stop SESSIONS [flags]
```

### Arguments

- `SESSIONS` (required). One to 100 session UUIDs or stable slugs.

### Flags

- `--idempotency-key <value>` (value). Identify this attempt (a retry can enqueue another stop request).

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

## polymorfa session tier confirm

Confirm a reviewed Number tier quote.

Confirm a reviewed Number tier quote.

This charges the quoted credits and records any Hybrid Link choice in the quote. The CLI never creates or confirms a replacement quote; after a conflict, review a new quote.

### Usage

```bash
polymorfa session tier confirm SESSION [flags]
```

### Arguments

- `SESSION` (required). Number session UUID or stable slug that was quoted.

### Flags

- `--idempotency-key <value>` (value). Identify this confirmation attempt.
- `--quote <value>` (value, required). Quote ID returned by `session tier quote`.
- `--yes` (boolean, required). Confirm the quoted charge and any Hybrid Link connection change.

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

### Examples

```bash
polymorfa session tier confirm support --quote QUOTE_UUID --yes
```

## polymorfa session tier quote

Preview a Number tier change without changing the Number or spending credit.

Preview a Number tier change without changing the Number or spending credit.

A Hybrid Link Number leaving Pro needs a choice: --keep one connection, or --split into two Standard Numbers. The choice runs when the paid Pro window ends. An upgrade to Pro can merge a same-number pair with --merge-with.

### Usage

```bash
polymorfa session tier quote SESSION [flags]
```

### Arguments

- `SESSION` (required). Number session UUID or stable slug. For a merge, this Number keeps its ID.

### Flags

- `--keep <value>` (value). Hybrid Link Number leaving Pro: keep this connection and disconnect the other. Values: `linked_devices`, `official_api`.
- `--merge-with <value>` (value). With --tier pro: UUID of the same-number Number to merge into this one. It is removed after its connection moves, so it must not use hosted message storage.
- `--new-number-name <value>` (value). With --split: name of the new Number.
- `--split` (boolean). Hybrid Link Number leaving Pro: split into two Standard Numbers without re-pairing.
- `--stay <value>` (value). With --split: the connection that stays on this Number; the other moves to the new Number. Values: `linked_devices`, `official_api`.
- `--tier <value>` (value, required). Target tier. "inherit" restores the project default tier. Values: `free`, `standard`, `pro`, `inherit`.

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

### Examples

```bash
polymorfa session tier quote support --tier pro
```

```bash
polymorfa session tier quote support --tier standard --keep linked_devices
```

```bash
polymorfa session tier quote support --tier standard --split --stay official_api --new-number-name support-linked
```

```bash
polymorfa session tier quote NUMBER_UUID --tier pro --merge-with OTHER_NUMBER_UUID
```

## polymorfa session tier status

Read a Number tier change and its Hybrid Link transition.

Read a Number tier change and its Hybrid Link transition.

The tier change is queued until applied or rejected. A Hybrid Link transition reports its own status: scheduled, running, completed, failed or cancelled.

### Usage

```bash
polymorfa session tier status SESSION QUOTE [flags]
```

### Arguments

- `SESSION` (required). Number session UUID or stable slug.
- `QUOTE` (required). Quote ID of the tier change.

### Flags

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

### Examples

```bash
polymorfa session tier status support QUOTE_UUID
```

## polymorfa session view

Read one session by its ID. Requires a team API key with sessions:read.

### Usage

```bash
polymorfa session view SESSION [flags]
```

### Arguments

- `SESSION` (required). Session ID.

### Flags

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

### Examples

```bash
polymorfa session view SESSION_ID --json
```
