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

polymorfa session

Manage Platform sessions.

Polymorfa CLI · CLI API requests

View as Markdown

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

polymorfa session capabilities SESSION [flags]

Examples

polymorfa session capabilities support-line
polymorfa session capabilities support-line --json

Arguments

  • SESSIONrequired

    Session ID or name.

Flags

Also accepts the global flags.

polymorfa session configuration get

Read effective session configuration, inheritance sources and revisions.

Usage

polymorfa session configuration get SESSION [flags]

Arguments

  • SESSIONrequired

    Session ID.

Flags

Also accepts the global flags.

polymorfa session configuration update

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

Usage

polymorfa session configuration update SESSION [flags]

Arguments

  • SESSIONrequired

    Session ID.

Flags

  • --input <value>takes a valuerequired

    JSON file or stdin (-), containing revision and configuration.set/reset.

Also accepts the global flags.

polymorfa session delete

Permanently remove matching sessions from management.

Usage

polymorfa session delete SESSIONS [flags]

Arguments

  • SESSIONSrequired

    One to 100 session UUIDs or stable slugs.

Flags

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

    Identify this attempt (a retry counts only rows still present).

  • --yesbooleanrequired

    Confirm permanent removal of every supplied session.

Also accepts the 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

polymorfa session hybrid-merge-candidates [flags]

Example

polymorfa session hybrid-merge-candidates --project PROJECT_UUID

Flags

Also accepts the global flags.

polymorfa session list

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

Usage

polymorfa session list [flags]

Examples

polymorfa session list
polymorfa session list --project PROJECT_ID --json

Flags

Also accepts the global flags.

polymorfa session status

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

Usage

polymorfa session status SESSION [flags]

Example

polymorfa session status SESSION_ID

Arguments

  • SESSIONrequired

    Session ID.

Flags

Also accepts the global flags.

polymorfa session stop

Request asynchronous stops for matching managed sessions.

Usage

polymorfa session stop SESSIONS [flags]

Arguments

  • SESSIONSrequired

    One to 100 session UUIDs or stable slugs.

Flags

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

    Identify this attempt (a retry can enqueue another stop request).

Also accepts the 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

polymorfa session tier confirm SESSION [flags]

Example

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

Arguments

  • SESSIONrequired

    Number session UUID or stable slug that was quoted.

Flags

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

    Identify this confirmation attempt.

  • --quote <value>takes a valuerequired

    Quote ID returned by session tier quote.

  • --yesbooleanrequired

    Confirm the quoted charge and any Hybrid Link connection change.

Also accepts the global flags.

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

polymorfa session tier quote SESSION [flags]

Examples

polymorfa session tier quote support --tier pro
polymorfa session tier quote support --tier standard --keep linked_devices
polymorfa session tier quote support --tier standard --split --stay official_api --new-number-name support-linked
polymorfa session tier quote NUMBER_UUID --tier pro --merge-with OTHER_NUMBER_UUID

Arguments

  • SESSIONrequired

    Number session UUID or stable slug. For a merge, this Number keeps its ID.

Flags

  • --keep <value>takes a value

    Hybrid Link Number leaving Pro: keep this connection and disconnect the other.

    Allowed valueslinked_devicesofficial_api
  • --merge-with <value>takes a 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>takes a value

    With --split: name of the new Number.

  • --splitboolean

    Hybrid Link Number leaving Pro: split into two Standard Numbers without re-pairing.

  • --stay <value>takes a value

    With --split: the connection that stays on this Number; the other moves to the new Number.

    Allowed valueslinked_devicesofficial_api
  • --tier <value>takes a valuerequired

    Target tier. "inherit" restores the project default tier.

    Allowed valuesfreestandardproinherit

Also accepts the global flags.

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

polymorfa session tier status SESSION QUOTE [flags]

Example

polymorfa session tier status support QUOTE_UUID

Arguments

  • SESSIONrequired

    Number session UUID or stable slug.

  • QUOTErequired

    Quote ID of the tier change.

Flags

Also accepts the global flags.

polymorfa session view

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

Usage

polymorfa session view SESSION [flags]

Example

polymorfa session view SESSION_ID --json

Arguments

  • SESSIONrequired

    Session ID.

Flags

Also accepts the global flags.