Skip to content
Shortcut: /, ⌘K or Ctrl+K

polymorfa group

Inspect and manage Messaging groups.

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa group capabilities

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

Usage

polymorfa group capabilities GROUP [flags]

Examples

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

Arguments

  • GROUPrequired

    Polymorfa group identifier.

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group create

Create a group with initial participants.

Usage

polymorfa group create [flags]

Example

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

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this creation.

  • --name <value>takes a valuerequired

    Group subject.

  • --participant <value>takes a valuerequiredrepeatable

    Polymorfa user ID to add. Repeat for several participants.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group description

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

Usage

polymorfa group description GROUP [flags]

Example

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

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this change.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --value <value>takes a valuerequired

    New description. An empty string clears it.

Also accepts the global flags.

polymorfa group list

List groups for a Messaging session.

Usage

polymorfa group list [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group participants add

Add participants to a group.

Usage

polymorfa group participants add GROUP [flags]

Example

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

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this change.

  • --participant <value>takes a valuerequiredrepeatable

    Polymorfa user ID. Repeat for several participants.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group participants demote

Demote group admins to regular participants.

Usage

polymorfa group participants demote GROUP [flags]

Example

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

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this change.

  • --participant <value>takes a valuerequiredrepeatable

    Polymorfa user ID. Repeat for several participants.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group participants list

List participants in a group.

Usage

polymorfa group participants list GROUP [flags]

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group participants promote

Promote participants to group admins.

Usage

polymorfa group participants promote GROUP [flags]

Example

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

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this change.

  • --participant <value>takes a valuerequiredrepeatable

    Polymorfa user ID. Repeat for several participants.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group participants remove

Remove participants from a group.

Usage

polymorfa group participants remove GROUP [flags]

Example

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

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this change.

  • --participant <value>takes a valuerequiredrepeatable

    Polymorfa user ID. Repeat for several participants.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --yesboolean

    Confirm removal without an interactive prompt.

Also accepts the global flags.

polymorfa group settings

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

Usage

polymorfa group settings GROUP [flags]

Example

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

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --info-editing <value>takes a value

    Who can edit the subject, description, and picture.

    Allowed valuesadminsall
  • --join-approval <value>takes a value

    Require admin approval for join requests.

    Allowed valuesonoff
  • --member-add <value>takes a value

    Who can add members.

    Allowed valuesadminsall
  • --messaging <value>takes a value

    Who can send messages.

    Allowed valuesadminsall
  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa group subject

Rename a group.

Usage

polymorfa group subject GROUP [flags]

Example

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

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this change.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --value <value>takes a valuerequired

    New group subject.

Also accepts the global flags.

polymorfa group view

View one group.

Usage

polymorfa group view GROUP [flags]

Arguments

  • GROUPrequired

    Group identifier.

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.