Loyalty: programs commands

Reference for the `revenexx loyalty-programs` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx loyalty-programs subcommand, with a runnable example and the flags it accepts. Each flag is an API field: its type, allowed values and meaning are in the API reference. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx loyalty-programs <command> --help for the live options.

create

Bash
revenexx loyalty-programs create \
    --code '' \
    --kind points \
    --labels

Flags: --code <code> --kind <kind> --labels <labels> --active [value] --auto-enroll [value] --currency <currency> --description <description> --external-id <external-id> --external-refs <external-refs> --holder <holder> --metadata <metadata> --period <period> --source-data <source-data> --source-synced-at <source-synced-at>

delete

Bash
revenexx loyalty-programs delete \
    --id ''

Flags: --id <id>

empty-trash

Bash
revenexx loyalty-programs empty-trash

figures

Bash
revenexx loyalty-programs figures \
    --id ''

Flags: --id <id>

get

Bash
revenexx loyalty-programs get \
    --id ''

Flags: --id <id>

list

Bash
revenexx loyalty-programs list

Flags: --limit <limit> --offset <offset> --order <order> --trashed <trashed> --id <id> --code <code> --description <description> --kind <kind> --holder <holder> --currency <currency> --period <period> --auto-enroll <auto-enroll> --active <active> --member-count <member-count> --external-id <external-id> --deleted-by <deleted-by> --deleted-by-id <deleted-by-id> --trash-batch <trash-batch> --purge-blocked-reason <purge-blocked-reason> --filter <column=value>

open-period

Bash
revenexx loyalty-programs open-period \
    --id ''

Flags: --id <id> --period <period>

purge

Bash
revenexx loyalty-programs purge

restore

Bash
revenexx loyalty-programs restore \
    --id ''

Flags: --id <id>

update

Bash
revenexx loyalty-programs update \
    --id ''

Flags: --id <id> --active [value] --auto-enroll [value] --code <code> --currency <currency> --description <description> --external-id <external-id> --external-refs <external-refs> --holder <holder> --kind <kind> --labels <labels> --metadata <metadata> --period <period> --source-data <source-data> --source-synced-at <source-synced-at>

Was this page helpful?