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

polymorfa cloud

Official API Number operations (beta). Team enrollment and scopes apply.

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa cloud catalog list

List visible Meta product catalogs for a WhatsApp Business Account. Requires sessions:read and Graph access.

Usage

polymorfa cloud catalog list [flags]

Flags

  • --after <value>takes a value

    Opaque cursor from the previous response.

  • --graph-version <value>takes a valuerequired

    Meta Graph version, for example v26.0.

  • --limit <value>takes a value

    Page size from 1 to 100; API default is 25.

  • --waba <value>takes a valuerequired

    WhatsApp Business Account ID.

Also accepts the global flags.

polymorfa cloud catalog products

List products in a catalog linked to an Official API WABA (beta). Requires sessions:read and Graph access.

Usage

polymorfa cloud catalog products [flags]

Flags

  • --after <value>takes a value

    Opaque cursor from the previous response.

  • --catalog <value>takes a valuerequired

    Numeric product catalog ID linked to the WABA.

  • --graph-version <value>takes a valuerequired

    Meta Graph version, for example v26.0.

  • --limit <value>takes a value

    Page size from 1 to 100; API default is 25.

  • --waba <value>takes a valuerequired

    WhatsApp Business Account ID.

Also accepts the global flags.

polymorfa cloud credentials get

Read redacted Meta credential checks for an enrolled Official API Number (beta). Requires sessions:read.

Usage

polymorfa cloud credentials get [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud credentials reauthorize

Create one reauthorization QuickLink for a stopped or disconnected standalone Official API Number (beta). Requires quicklink:manage. Never stops the Number or retries link creation.

Usage

polymorfa cloud credentials reauthorize [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud group create

Ask WhatsApp to create an Official group (beta). Requires groups:manage, team enrollment and an Official Business Account. Sends once; the group ID and invite link arrive in a group.update event carrying the returned requestId.

Usage

polymorfa cloud group create [flags]

Flags

  • --description <value>takes a value

    Group description, at most 2048 characters.

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API answers instead of changing the group again.

  • --join-approvalboolean

    Require approval for people who open the invite link.

  • --session <value>takes a valuerequired

    Messaging Number ID.

  • --subject <value>takes a valuerequired

    Group subject, 1 to 128 characters.

Also accepts the global flags.

polymorfa cloud group delete

Delete an Official group and remove every participant, including your business (beta). Requires groups:manage. Does not retry an uncertain write.

Usage

polymorfa cloud group delete GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API answers instead of changing the group again.

  • --session <value>takes a valuerequired

    Messaging Number ID.

  • --yesbooleanrequired

    Confirm deleting the group for every participant.

Also accepts the global flags.

polymorfa cloud group get

Read an Official group: subject, description, participants and settings (beta). Requires groups:read.

Usage

polymorfa cloud group get GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud group join-requests approve

Approve open join requests for an Official group (beta). Requires groups:manage. Sends once; requests WhatsApp could not approve are listed in failed.

Usage

polymorfa cloud group join-requests approve GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API answers instead of changing the group again.

  • --request <value>takes a valuerequiredrepeatable

    Join request ID. Repeat for several.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud group join-requests list

List open join requests for an Official group that requires approval (beta). Requires groups:read.

Usage

polymorfa cloud group join-requests list GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

  • --after <value>takes a value

    Cursor from a previous page (cursors.after).

  • --before <value>takes a value

    Cursor from a previous page (cursors.before).

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud group join-requests reject

Reject open join requests for an Official group (beta). Requires groups:manage. Sends once; requests WhatsApp could not reject are listed in failed.

Usage

polymorfa cloud group join-requests reject GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API answers instead of changing the group again.

  • --request <value>takes a valuerequiredrepeatable

    Join request ID. Repeat for several.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud group list

List Official groups on an Official API Number (beta). Requires groups:read and team enrollment.

Usage

polymorfa cloud group list [flags]

Flags

  • --after <value>takes a value

    Cursor from a previous page (cursors.after).

  • --before <value>takes a value

    Cursor from a previous page (cursors.before).

  • --limit <value>takes a value

    Groups per page, 1 to 1024.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud group pin

Pin an Official group message for 1 to 30 days, or unpin it with --unpin (beta). At most three messages stay pinned. Requires groups:manage. Sends once.

Usage

polymorfa cloud group pin GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

  • --days <value>takes a value

    Pin duration, 1 to 30 days.

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API answers instead of changing the group again.

  • --message <value>takes a valuerequired

    ID of a message in this group.

  • --session <value>takes a valuerequired

    Messaging Number ID.

  • --unpinboolean

    Unpin the message.

Also accepts the global flags.

polymorfa cloud group remove-participants

Remove up to eight participants from an Official group (beta). A removed participant cannot rejoin with the invite link. Requires groups:manage. Sends once.

Usage

polymorfa cloud group remove-participants GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API answers instead of changing the group again.

  • --participant <value>takes a valuerequiredrepeatable

    Conversation ID or E.164 phone number. Repeat up to eight times.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud group update

Change an Official group subject or description (beta). Requires groups:manage. Sends once; a group.update event reports what WhatsApp applied.

Usage

polymorfa cloud group update GROUP [flags]

Arguments

  • GROUPrequired

    Conversation ID of the group.

Flags

  • --description <value>takes a value

    New description, at most 2048 characters.

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API answers instead of changing the group again.

  • --session <value>takes a valuerequired

    Messaging Number ID.

  • --subject <value>takes a value

    New subject, 1 to 128 characters.

Also accepts the global flags.

polymorfa cloud marketing status

Read raw Marketing Messages WABA status strings (beta). Requires sessions:read and Graph access.

Usage

polymorfa cloud marketing status [flags]

Flags

  • --graph-version <value>takes a valuerequired

    Meta Graph version, for example v26.0.

  • --waba <value>takes a valuerequired

    WhatsApp Business Account ID from an Official API Number in your project.

Also accepts the global flags.

polymorfa cloud pricing

Read Meta-reported message counts (beta), without prices or invoice amounts. Requires sessions:read and service-window enrollment.

Usage

polymorfa cloud pricing [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

  • --since <value>takes a value

    Inclusive ISO 8601 start; defaults to 30 days before until.

  • --until <value>takes a value

    Exclusive ISO 8601 end; defaults to now. Maximum period: 93 days.

Also accepts the global flags.

polymorfa cloud service-window

Read the observed customer service window (beta). Unknown does not establish permission to send. Requires chats:read and service-window enrollment; HMS is not required.

Usage

polymorfa cloud service-window CONVERSATION [flags]

Arguments

  • CONVERSATIONrequired

    Conversation ID or E.164 phone number.

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud template create

Submit one Meta template (beta). Requires messages:write. Sends once; pass --idempotency-key so a manual retry cannot submit twice.

Usage

polymorfa cloud template create [flags]

Flags

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API returns idempotency_completed instead of writing again.

  • --input <value>takes a valuerequired

    Template JSON file or - for stdin: name, language, category, components.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud template delete

Delete every language of a Meta template name (beta). Requires messages:write. Does not retry an uncertain write.

Usage

polymorfa cloud template delete NAME [flags]

Arguments

  • NAMErequired

    Meta template name to delete in all languages.

Flags

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

    Key that fences a manual retry: reuse it after an unknown outcome and the API returns idempotency_completed instead of writing again.

  • --session <value>takes a valuerequired

    Messaging Number ID.

  • --yesbooleanrequired

    Confirm deletion of all language variants.

Also accepts the global flags.

polymorfa cloud template edit

Submit changes to one Meta template language (beta). Requires messages:write. Acceptance does not establish approval.

Usage

polymorfa cloud template edit NAME [flags]

Arguments

  • NAMErequired

    Meta template name.

Flags

  • --input <value>takes a valuerequired

    JSON file or - for stdin containing components.

  • --language <value>takes a value

    Template language; API default is en_US.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud template get

Read a Meta template by name and language (beta). Omitted language defaults to en_US; requires messages:write.

Usage

polymorfa cloud template get NAME [flags]

Arguments

  • NAMErequired

    Meta template name.

Flags

  • --language <value>takes a value

    Template language; defaults to en_US at the API.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa cloud template list

List the refreshed Meta template catalog for an Official API Number (beta). Requires messages:write.

Usage

polymorfa cloud template list [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.