Marketing consents: subscriptions commands

Reference for the `revenexx marketing-consents-subscriptions` 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 marketing-consents-subscriptions 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 marketing-consents-subscriptions <command> --help for the live options.

confirm

Bash

revenexx marketing-consents-subscriptions confirm \
    --token '' \
    --purchase-request-id ''

Flags: --subscriptions-token <subscriptions-token> --purchase-request-id <purchase-request-id> --allocations [allocations...] --currency <currency> --note <note> --order-id <order-id>

get

Bash

revenexx marketing-consents-subscriptions get \
    --id ''

Flags: --id <id>

list

Bash

revenexx marketing-consents-subscriptions list

Flags: --id <id> --contact-id <contact-id> --channel <channel> --address <address> --address-hash <address-hash> --subscription-type-id <subscription-type-id> --state <state> --legal-basis <legal-basis> --consent-text-id <consent-text-id> --locale <locale> --market <market> --campaign-ref <campaign-ref> --source <source> --source-ref <source-ref> --requested-at <requested-at> --confirmation-sent-at <confirmation-sent-at> --confirmed-at <confirmed-at> --withdrawn-at <withdrawn-at> --lapse-at <lapse-at> --erased-at <erased-at> --suppression-written-at <suppression-written-at> --suppression-ref <suppression-ref> --external-id <external-id> --source-synced-at <source-synced-at> --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

marketing-consents-eligibility-check

Bash

revenexx marketing-consents-subscriptions marketing-consents-eligibility-check \
    --recipients one two three \
    --subscription-type newsletter

Flags: --recipients [recipients...] --subscription-type <subscription-type> --channel <channel>

marketing-consents-preferences-get

Bash

revenexx marketing-consents-subscriptions marketing-consents-preferences-get \
    --token ''

Flags: --subscriptions-token <subscriptions-token> --locale <locale>

marketing-consents-preferences-links

Bash

revenexx marketing-consents-subscriptions marketing-consents-preferences-links \
    --recipients one two three

Flags: --recipients [recipients...] --channel <channel>

marketing-consents-preferences-update

Bash

revenexx marketing-consents-subscriptions marketing-consents-preferences-update \
    --token ''

Flags: --subscriptions-token <subscriptions-token> --choices [choices...] --ip <ip> --locale <locale> --unsubscribe-all [value] --user-agent <user-agent>

request

Bash

revenexx marketing-consents-subscriptions request \
    --subscription-type newsletter

Flags: --subscription-type <subscription-type> --address <address> --campaign-ref <campaign-ref> --channel <channel> --consent-text-id <consent-text-id> --contact-id <contact-id> --email <email> --first-name <first-name> --ip <ip> --last-name <last-name> --locale <locale> --page-url <page-url> --phone <phone> --source <source> --source-ref <source-ref> --user-agent <user-agent>

withdraw

Bash

revenexx marketing-consents-subscriptions withdraw \
    --id '' \
    --purchase-request-id ''

Flags: --id <id> --purchase-request-id <purchase-request-id> --allocations [allocations...] --currency <currency> --note <note>

Was this page helpful?