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

polymorfa flow

Manage project Flow drafts and their Official API lifecycle.

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa flow create

Create a local project Flow draft. Requires sessions:manage.

Usage

polymorfa flow create [flags]

Flags

  • --input <value>takes a valuerequired

    JSON file or - for stdin. Project and path identity come from command flags.

Also accepts the global flags.

polymorfa flow delete

Delete a local Flow draft. Requires sessions:manage.

Usage

polymorfa flow delete FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --yesbooleanrequired

    Confirm this Flow change.

Also accepts the global flags.

polymorfa flow deprecate

Deprecate a published WhatsApp Flow (beta). Requires sessions:manage.

Usage

polymorfa flow deprecate FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --request-id <value>takes a value

    UUID for this exact provider operation. Reuse to inspect the original receipt.

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

  • --yesbooleanrequired

    Confirm this Flow change.

Also accepts the global flags.

polymorfa flow discard

Delete a draft from WhatsApp (beta). Requires sessions:manage.

Usage

polymorfa flow discard FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --request-id <value>takes a value

    UUID for this exact provider operation. Reuse to inspect the original receipt.

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

  • --yesbooleanrequired

    Confirm this Flow change.

Also accepts the global flags.

polymorfa flow endpoint delete

Remove a Flow's data endpoint on one Number (beta). WhatsApp requests to it are refused afterwards; receipts are kept. Requires sessions:manage.

Usage

polymorfa flow endpoint delete FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

  • --yesboolean

    Confirm removing the endpoint.

Also accepts the global flags.

polymorfa flow endpoint get

Read a Flow's data endpoint on one Number and the Number's encryption custody (beta). Requires sessions:read.

Usage

polymorfa flow endpoint get FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

Also accepts the global flags.

polymorfa flow endpoint receipts

Read a Flow's data-exchange receipts, newest first (beta). Metadata only: no form data, Flow token or response. Requires sessions:read.

Usage

polymorfa flow endpoint receipts FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --limit <value>takes a value

    1 to 100 receipts.

  • --session <value>takes a value

    Only this Number (name or ID).

Also accepts the global flags.

polymorfa flow endpoint set

Create or replace a Flow's data endpoint on one Number (beta). Requires sessions:manage. forward and function need a Polymorfa-managed key; direct needs your own key. A forward signing secret is printed once. Makes one attempt.

Usage

polymorfa flow endpoint set FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --deployment <value>takes a value

    Pin an immutable Function deployment UUID.

  • --disabledboolean

    Save the endpoint disabled; WhatsApp requests are refused.

  • --expected-revision <value>takes a value

    Replace only when the stored revision matches.

  • --function <value>takes a value

    Function UUID for function mode.

  • --mode <value>takes a valuerequired

    forward: Polymorfa decrypts and forwards signed JSON to --url. function: runs --function. direct: WhatsApp calls --url with your own key.

    Allowed valuesforwardfunctiondirect
  • --rotate-signing-secretboolean

    Issue a new forward signing secret.

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

  • --url <value>takes a value

    HTTPS URL for forward or direct.

Also accepts the global flags.

polymorfa flow get

Read a project Flow draft. Requires sessions:read.

Usage

polymorfa flow get FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

Also accepts the global flags.

polymorfa flow key custody

Read whether Polymorfa holds a Number's Flow encryption key (managed) or not (customer), and recent managed keys (beta). Requires sessions:read.

Usage

polymorfa flow key custody [flags]

Flags

  • --session <value>takes a valuerequired

    Number name or ID in the project.

Also accepts the global flags.

polymorfa flow key get

Read the public Flow encryption key registered to a Meta phone number. Requires sessions:read.

Usage

polymorfa flow key get [flags]

Flags

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

    Meta Graph version, for example v26.0.

  • --phone-number-id <value>takes a valuerequired

    Meta phone number ID.

Also accepts the global flags.

polymorfa flow key register

Replace the public key used by every dynamic Flow on this Meta phone number. Requires sessions:manage; retain the matching private key on your endpoint.

Usage

polymorfa flow key register [flags]

Flags

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

    Meta Graph version, for example v26.0.

  • --input <value>takes a valuerequired

    JSON file containing business_public_key, or - for stdin.

  • --phone-number-id <value>takes a valuerequired

    Meta phone number ID.

  • --yesbooleanrequired

    Confirm replacing the public key for every Flow on this phone number.

Also accepts the global flags.

polymorfa flow key rotate

Generate and register a new Polymorfa-managed Flow encryption key for a Number (beta). Every dynamic Flow on the Number uses it; the previous managed key decrypts for 24 hours. Requires sessions:manage. Makes one attempt.

Usage

polymorfa flow key rotate [flags]

Flags

  • --session <value>takes a valuerequired

    Number name or ID in the project.

  • --yesboolean

    Confirm replacing the key for every Flow on this Number.

Also accepts the global flags.

polymorfa flow list

List project Flow drafts. Requires sessions:read.

Usage

polymorfa flow list [flags]

Flags

Also accepts the global flags.

polymorfa flow publish

Publish a validated Flow to WhatsApp (beta). Requires sessions:manage.

Usage

polymorfa flow publish FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --request-id <value>takes a value

    UUID for this exact provider operation. Reuse to inspect the original receipt.

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

  • --yesbooleanrequired

    Confirm this Flow change.

Also accepts the global flags.

polymorfa flow receipts

Read provider operation receipts, including uncertain outcomes. Requires sessions:read.

Usage

polymorfa flow receipts FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

Also accepts the global flags.

polymorfa flow sync

Reconcile provider status without replaying uncertain writes (beta). Requires sessions:manage.

Usage

polymorfa flow sync FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --request-id <value>takes a value

    UUID for this exact provider operation. Reuse to inspect the original receipt.

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

Also accepts the global flags.

polymorfa flow update

Update a local project Flow draft. Requires sessions:manage.

Usage

polymorfa flow update FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --input <value>takes a valuerequired

    JSON file or - for stdin. Project and path identity come from command flags.

Also accepts the global flags.

polymorfa flow upload

Upload the Flow to one Number (beta). Requires sessions:manage. Does not retry uncertain writes.

Usage

polymorfa flow upload FLOW [flags]

Arguments

  • FLOWrequired

    Flow draft UUID.

Flags

  • --category <value>takes a valuerepeatable

    WhatsApp Flow category; repeat for multiple categories.

    Allowed valuesSIGN_UPSIGN_INAPPOINTMENT_BOOKINGLEAD_GENERATIONCONTACT_USCUSTOMER_SUPPORTSURVEYOTHER
  • --request-id <value>takes a value

    UUID for this exact provider operation. Reuse to inspect the original receipt.

  • --session <value>takes a valuerequired

    Number name or ID in the same project.

Also accepts the global flags.