Customers: contacts commands

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

create

Bash
revenexx customers-contacts create \
    --email einkauf@example.com

Flags: --email <email> --created-at <created-at> --external-id <external-id> --first-name <first-name> --is-primary [value] --job-title <job-title> --last-name <last-name> --locale <locale> --order-approval-limit <order-approval-limit> --order-approval-mode <order-approval-mode> --organization-id <organization-id> --phone <phone> --registration-status <registration-status> --role <role> --status <status>

customers-contact-events-get

Bash
revenexx customers-contacts customers-contact-events-get \
    --id ''

Flags: --id <id>

customers-contact-events-list

Bash
revenexx customers-contacts customers-contact-events-list

Flags: --id <id> --contact-id <contact-id> --organization-id <organization-id> --kind <kind> --name <name> --subject <subject> --actor <actor> --occurred-at <occurred-at> --due-at <due-at> --assignee <assignee> --done-at <done-at> --created-at <created-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

customers-organizations-events-create

Bash
revenexx customers-contacts customers-organizations-events-create \
    --organization-id '' \
    --contact-id '' \
    --subject Called about the annual requirement

Flags: --organization-id <organization-id> --contact-id <contact-id> --subject <subject> --actor <actor> --kind <kind> --note <note> --occurred-at <occurred-at>

customers-registrations-approve

Bash
revenexx customers-contacts customers-registrations-approve \
    --contact-id ''

Flags: --contact-id <contact-id> --decided-by <decided-by>

customers-registrations-reject

Bash
revenexx customers-contacts customers-registrations-reject \
    --contact-id '' \
    --reason Could not be verified as a commercial buyer.

Flags: --contact-id <contact-id> --reason <reason> --decided-by <decided-by>

delete

Bash
revenexx customers-contacts delete \
    --id ''

Flags: --id <id>

erase

Bash
revenexx customers-contacts erase \
    --id ''

Flags: --id <id>

events-create

Bash
revenexx customers-contacts events-create \
    --contact-id '' \
    --subject Called about the annual requirement

Flags: --contact-id <contact-id> --subject <subject> --actor <actor> --kind <kind> --note <note> --occurred-at <occurred-at>

get

Bash
revenexx customers-contacts get \
    --id ''

Flags: --id <id>

identity

Bash
revenexx customers-contacts identity \
    --contact-id ''

Flags: --contact-id <contact-id> --created-by <created-by>

invite

Bash
revenexx customers-contacts invite \
    --contact-id ''

Flags: --contact-id <contact-id> --invited-by <invited-by> --url <url>

list

Bash
revenexx customers-contacts list

Flags: --id <id> --organization-id <organization-id> --email <email> --username <username> --first-name <first-name> --last-name <last-name> --phone <phone> --job-title <job-title> --role <role> --status <status> --shop-access <shop-access> --invited-at <invited-at> --access-blocked-reason <access-blocked-reason> --order-approval-mode <order-approval-mode> --order-approval-limit <order-approval-limit> --registration-status <registration-status> --registration-decided-at <registration-decided-at> --registration-decided-by <registration-decided-by> --registration-reason <registration-reason> --locale <locale> --consent-marketing [value] --lifecycle-stage <lifecycle-stage> --lifecycle-changed-at <lifecycle-changed-at> --lead-source <lead-source> --lead-source-ref <lead-source-ref> --owner-id <owner-id> --lead-score <lead-score> --consent-marketing-synced-at <consent-marketing-synced-at> --is-primary [value] --external-user-id <external-user-id> --external-id <external-id> --source-synced-at <source-synced-at> --deleted-at <deleted-at> --deleted-by <deleted-by> --deleted-by-id <deleted-by-id> --trash-batch <trash-batch> --purge-at <purge-at> --purge-blocked-reason <purge-blocked-reason> --created-at <created-at> --updated-at <updated-at> --trashed <trashed> --limit <limit> --offset <offset> --order <order> --filter <column=value>

permissions

Bash
revenexx customers-contacts permissions \
    --contact-id ''

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

reinvite

Bash
revenexx customers-contacts reinvite \
    --contact-id ''

Flags: --contact-id <contact-id> --url <url>

restore

Bash
revenexx customers-contacts restore \
    --id ''

Flags: --id <id>

restore-access

Bash
revenexx customers-contacts restore-access \
    --contact-id ''

Flags: --contact-id <contact-id> --actor <actor>

revoke-access

Bash
revenexx customers-contacts revoke-access \
    --contact-id '' \
    --reason left_company

Flags: --contact-id <contact-id> --reason <reason> --actor <actor> --note <note>

trash-empty

Bash
revenexx customers-contacts trash-empty

update

Bash
revenexx customers-contacts update \
    --id ''

Flags: --id <id> --email <email> --external-id <external-id> --first-name <first-name> --is-primary [value] --job-title <job-title> --last-name <last-name> --locale <locale> --order-approval-limit <order-approval-limit> --order-approval-mode <order-approval-mode> --organization-id <organization-id> --phone <phone> --role <role> --status <status>

Was this page helpful?