Loyalty: referrals commands

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-referrals 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-referrals <command> --help for the live options.

claim

revenexx loyalty-referrals claim \
    --code '' \
    --contact-id ''

Flags: --code <code> --contact-id <contact-id>

codes-deactivate

revenexx loyalty-referrals codes-deactivate \
    --id '' \
    --data '{ "key": "value" }'

Flags: --id <id> --body <body>

codes-get

revenexx loyalty-referrals codes-get \
    --id ''

Flags: --id <id>

codes-list

revenexx loyalty-referrals codes-list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --membership-id <membership-id> --contact-id <contact-id> --code <code> --uses <uses> --active <active> --filter <column=value>

get

revenexx loyalty-referrals get \
    --id ''

Flags: --id <id>

list

revenexx loyalty-referrals list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --referral-code-id <referral-code-id> --referrer-membership-id <referrer-membership-id> --referrer-contact-id <referrer-contact-id> --referee-contact-id <referee-contact-id> --state <state> --order-id <order-id> --reason <reason> --referee-voucher-code <referee-voucher-code> --referrer-voucher-code <referrer-voucher-code> --filter <column=value>

reject

revenexx loyalty-referrals reject \
    --id '' \
    --reason ''

Flags: --id <id> --reason <reason>

reward

revenexx loyalty-referrals reward \
    --id '' \
    --data '{ "key": "value" }'

Flags: --id <id> --body <body>