# polymorfa group

> Inspect and manage Messaging groups.

## Commands

- [polymorfa group capabilities](https://docs.polymorfa.com/cli/group/capabilities): Read stored WhatsApp group capabilities. Requires current membership and enrollment in the number-capabilities beta.
- [polymorfa group create](https://docs.polymorfa.com/cli/group/create): Create a group with initial participants.
- [polymorfa group description](https://docs.polymorfa.com/cli/group/description): Replace a group description. Pass an empty value to clear it.
- [polymorfa group invite-link](https://docs.polymorfa.com/cli/group/invite-link): Print the current invite link for a group.
- [polymorfa group list](https://docs.polymorfa.com/cli/group/list): List groups for a Messaging session.
- [polymorfa group participants add](https://docs.polymorfa.com/cli/group/participants-add): Add participants to a group.
- [polymorfa group participants demote](https://docs.polymorfa.com/cli/group/participants-demote): Demote group admins to regular participants.
- [polymorfa group participants list](https://docs.polymorfa.com/cli/group/participants-list): List participants in a group.
- [polymorfa group participants promote](https://docs.polymorfa.com/cli/group/participants-promote): Promote participants to group admins.
- [polymorfa group participants remove](https://docs.polymorfa.com/cli/group/participants-remove): Remove participants from a group.
- [polymorfa group settings](https://docs.polymorfa.com/cli/group/settings): Change who can edit group info, send messages, and add members, and whether joining needs admin approval.
- [polymorfa group subject](https://docs.polymorfa.com/cli/group/subject): Rename a group.
- [polymorfa group view](https://docs.polymorfa.com/cli/group/view): View one group.

## polymorfa group capabilities

Read stored WhatsApp group capabilities. Requires current membership and enrollment in the number-capabilities beta.

### Usage

```bash
polymorfa group capabilities GROUP [flags]
```

### Arguments

- `GROUP` (required). Polymorfa group identifier.

### Flags

- `--session <value>` (value, required). Messaging session ID.

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

### Examples

```bash
polymorfa group capabilities 9007199254740993 --session support
```

```bash
polymorfa group capabilities 9007199254740993 --session support --json
```

## polymorfa group create

Create a group with initial participants.

### Usage

```bash
polymorfa group create [flags]
```

### Flags

- `--idempotency-key <value>` (value). Safely identify retries of this creation.
- `--name <value>` (value, required). Group subject.
- `--participant <value>` (value, required, repeatable). Polymorfa user ID to add. Repeat for several participants.
- `--session <value>` (value, required). Messaging session ID.

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

### Examples

```bash
polymorfa group create --session session_123 --name "Launch team" --participant 750000000001 --participant 750000000002
```

## polymorfa group description

Replace a group description. Pass an empty value to clear it.

### Usage

```bash
polymorfa group description GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--idempotency-key <value>` (value). Safely identify retries of this change.
- `--session <value>` (value, required). Messaging session ID.
- `--value <value>` (value, required). New description. An empty string clears it.

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

### Examples

```bash
polymorfa group description 750000000009 --session session_123 --value "Weekly launch coordination"
```

## polymorfa group invite-link

Print the current invite link for a group.

### Usage

```bash
polymorfa group invite-link GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--session <value>` (value, required). Messaging session ID.

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

## polymorfa group list

List groups for a Messaging session.

### Usage

```bash
polymorfa group list [flags]
```

### Flags

- `--session <value>` (value, required). Messaging session ID.

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

## polymorfa group participants add

Add participants to a group.

### Usage

```bash
polymorfa group participants add GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--idempotency-key <value>` (value). Safely identify retries of this change.
- `--participant <value>` (value, required, repeatable). Polymorfa user ID. Repeat for several participants.
- `--session <value>` (value, required). Messaging session ID.

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

### Examples

```bash
polymorfa group participants add 750000000009 --session session_123 --participant 750000000001
```

## polymorfa group participants demote

Demote group admins to regular participants.

### Usage

```bash
polymorfa group participants demote GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--idempotency-key <value>` (value). Safely identify retries of this change.
- `--participant <value>` (value, required, repeatable). Polymorfa user ID. Repeat for several participants.
- `--session <value>` (value, required). Messaging session ID.

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

### Examples

```bash
polymorfa group participants demote 750000000009 --session session_123 --participant 750000000001
```

## polymorfa group participants list

List participants in a group.

### Usage

```bash
polymorfa group participants list GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--session <value>` (value, required). Messaging session ID.

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

## polymorfa group participants promote

Promote participants to group admins.

### Usage

```bash
polymorfa group participants promote GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--idempotency-key <value>` (value). Safely identify retries of this change.
- `--participant <value>` (value, required, repeatable). Polymorfa user ID. Repeat for several participants.
- `--session <value>` (value, required). Messaging session ID.

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

### Examples

```bash
polymorfa group participants promote 750000000009 --session session_123 --participant 750000000001
```

## polymorfa group participants remove

Remove participants from a group.

### Usage

```bash
polymorfa group participants remove GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--idempotency-key <value>` (value). Safely identify retries of this change.
- `--participant <value>` (value, required, repeatable). Polymorfa user ID. Repeat for several participants.
- `--session <value>` (value, required). Messaging session ID.
- `--yes` (boolean). Confirm removal without an interactive prompt.

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

### Examples

```bash
polymorfa group participants remove 750000000009 --session session_123 --participant 750000000001 --yes
```

## polymorfa group settings

Change who can edit group info, send messages, and add members, and whether joining needs admin approval.

### Usage

```bash
polymorfa group settings GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--info-editing <value>` (value). Who can edit the subject, description, and picture. Values: `admins`, `all`.
- `--join-approval <value>` (value). Require admin approval for join requests. Values: `on`, `off`.
- `--member-add <value>` (value). Who can add members. Values: `admins`, `all`.
- `--messaging <value>` (value). Who can send messages. Values: `admins`, `all`.
- `--session <value>` (value, required). Messaging session ID.

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

### Examples

```bash
polymorfa group settings 750000000009 --session session_123 --messaging admins --join-approval on
```

## polymorfa group subject

Rename a group.

### Usage

```bash
polymorfa group subject GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--idempotency-key <value>` (value). Safely identify retries of this change.
- `--session <value>` (value, required). Messaging session ID.
- `--value <value>` (value, required). New group subject.

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

### Examples

```bash
polymorfa group subject 750000000009 --session session_123 --value "Launch team"
```

## polymorfa group view

View one group.

### Usage

```bash
polymorfa group view GROUP [flags]
```

### Arguments

- `GROUP` (required). Group identifier.

### Flags

- `--session <value>` (value, required). Messaging session ID.

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