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

polymorfa customer

Manage project Customers, pairing links, and assigned Numbers.

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa customer archive

Archive a non-default Customer.

Usage

polymorfa customer archive CUSTOMER [flags]

Arguments

  • CUSTOMERrequired

    Customer ID.

Flags

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

    Identify this archive attempt for safe retries.

  • --yesbooleanrequired

    Confirm Customer archival.

Also accepts the global flags.

polymorfa customer create

Create a Customer.

Usage

polymorfa customer create [flags]

Flags

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

    Caller-defined Customer ID.

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

    Identify this create attempt for safe retries.

  • --name <value>takes a value

    Customer name.

Also accepts the global flags.

polymorfa customer enable

Enable Customers and assign existing Numbers to the default Customer.

Usage

polymorfa customer enable [flags]

Flags

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

    Identify this enablement attempt for safe retries.

Also accepts the global flags.

polymorfa customer event list

List recent events for a Customer.

Usage

polymorfa customer event list CUSTOMER [flags]

Arguments

  • CUSTOMERrequired

    Customer ID.

Flags

  • --limit <value>takes a value

    Maximum events to return.

Also accepts the global flags.

polymorfa customer list

List Customers in one project.

Usage

polymorfa customer list [flags]

Flags

  • --cursor <value>takes a value

    Continue from this cursor.

  • --default <value>takes a value

    Filter by default-Customer status.

    Allowed valuestruefalse
  • --has-numbers <value>takes a value

    Filter by whether a Customer has assigned Numbers.

    Allowed valuestruefalse
  • --limit <value>takes a value

    Maximum Customers to return.

  • --needs-attention <value>takes a value

    Filter by whether a Customer needs attention.

    Allowed valuestruefalse
  • --search <value>takes a value

    Search Customer profile fields.

  • --status <value>takes a value

    Filter by Customer status.

    Allowed valuesactivearchivingarchivedall

Also accepts the global flags.

polymorfa customer number list

List Numbers assigned to a Customer.

Usage

polymorfa customer number list CUSTOMER [flags]

Arguments

  • CUSTOMERrequired

    Customer ID.

Flags

Also accepts the global flags.

polymorfa customer number transfer

Transfer a Number between Customers.

Usage

polymorfa customer number transfer CUSTOMER SESSION [flags]

Arguments

  • CUSTOMERrequired

    Destination Customer ID.

  • SESSIONrequired

    Number session ID or slug.

Flags

  • --from <value>takes a valuerequired

    Source Customer ID.

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

    Identify this transfer attempt for safe retries.

  • --yesbooleanrequired

    Confirm the Number transfer.

Also accepts the global flags.

polymorfa customer restore

Restore an archived Customer.

Usage

polymorfa customer restore CUSTOMER [flags]

Arguments

  • CUSTOMERrequired

    Customer ID.

Flags

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

    Identify this restore attempt for safe retries.

Also accepts the global flags.

polymorfa customer status

Check whether Customers is enabled for a project.

Usage

polymorfa customer status [flags]

Flags

Also accepts the global flags.

polymorfa customer update

Update Customer profile fields.

Usage

polymorfa customer update CUSTOMER [flags]

Arguments

  • CUSTOMERrequired

    Customer ID.

Flags

  • --clear-external-idboolean

    Clear the caller-defined Customer ID.

  • --clear-nameboolean

    Clear the Customer name.

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

    New caller-defined Customer ID.

  • --name <value>takes a value

    New Customer name.

Also accepts the global flags.

polymorfa customer view

View one Customer.

Usage

polymorfa customer view CUSTOMER [flags]

Arguments

  • CUSTOMERrequired

    Customer ID.

Flags

Also accepts the global flags.