Loyalty: rewards commands

Reference for the `revenexx loyalty-rewards` 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-rewards 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-rewards <command> --help for the live options.

create

Bash

revenexx loyalty-rewards create \
    --code '' \
    --labels  \
    --points-cost 1 \
    --program-id '' \
    --promotion-id ''

Flags: --code <code> --labels <labels> --points-cost <points-cost> --program-id <program-id> --promotion-id <promotion-id> --active [value] --description <description> --external-id <external-id> --external-refs <external-refs> --metadata <metadata> --min-tier-id <min-tier-id> --source-data <source-data> --source-synced-at <source-synced-at> --voucher-batch-id <voucher-batch-id>

delete

Bash

revenexx loyalty-rewards delete \
    --id ''

Flags: --id <id>

empty-trash

Bash

revenexx loyalty-rewards empty-trash

get

Bash

revenexx loyalty-rewards get \
    --id ''

Flags: --id <id>

list

Bash

revenexx loyalty-rewards list

Flags: --limit <limit> --offset <offset> --order <order> --trashed <trashed> --id <id> --program-id <program-id> --code <code> --description <description> --points-cost <points-cost> --promotion-id <promotion-id> --voucher-batch-id <voucher-batch-id> --min-tier-id <min-tier-id> --active <active> --redeemed-count <redeemed-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>

purge

Bash

revenexx loyalty-rewards purge

redeem

Bash

revenexx loyalty-rewards redeem \
    --id ''

Flags: --id <id> --contact-id <contact-id> --key <key> --membership-id <membership-id> --organization-id <organization-id>

redemptions-get

Bash

revenexx loyalty-rewards redemptions-get \
    --id ''

Flags: --id <id>

redemptions-list

Bash

revenexx loyalty-rewards redemptions-list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --membership-id <membership-id> --reward-id <reward-id> --points <points> --voucher-code <voucher-code> --ledger-entry-id <ledger-entry-id> --request-key <request-key> --state <state> --used-order-id <used-order-id> --filter <column=value>

restore

Bash

revenexx loyalty-rewards restore \
    --id ''

Flags: --id <id>

update

Bash

revenexx loyalty-rewards update \
    --id ''

Flags: --id <id> --active [value] --code <code> --description <description> --external-id <external-id> --external-refs <external-refs> --labels <labels> --metadata <metadata> --min-tier-id <min-tier-id> --points-cost <points-cost> --program-id <program-id> --promotion-id <promotion-id> --source-data <source-data> --source-synced-at <source-synced-at> --voucher-batch-id <voucher-batch-id>

Was this page helpful?