Customers: segments commands

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

create

Bash

revenexx customers-segments create

Flags: --active [value] --code <code> --created-at <created-at> --labels <labels> --position <position> --rule-match <rule-match> --rules <rules>

customers-segment-members-create

Bash

revenexx customers-segments customers-segment-members-create \
    --organization-id '' \
    --segment-id ''

Flags: --organization-id <organization-id> --segment-id <segment-id> --created-at <created-at> --source <source>

customers-segment-members-delete

Bash

revenexx customers-segments customers-segment-members-delete \
    --id ''

Flags: --id <id>

customers-segment-members-get

Bash

revenexx customers-segments customers-segment-members-get \
    --id ''

Flags: --id <id>

customers-segment-members-list

Bash

revenexx customers-segments customers-segment-members-list

Flags: --id <id> --segment-id <segment-id> --organization-id <organization-id> --contact-id <contact-id> --source <source> --created-at <created-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

customers-segment-members-update

Bash

revenexx customers-segments customers-segment-members-update \
    --id ''

Flags: --id <id> --organization-id <organization-id> --segment-id <segment-id> --source <source>

delete

Bash

revenexx customers-segments delete \
    --id ''

Flags: --id <id>

get

Bash

revenexx customers-segments get \
    --id ''

Flags: --id <id>

list

Bash

revenexx customers-segments list

Flags: --id <id> --code <code> --position <position> --active [value] --rule-match <rule-match> --member-type <member-type> --rules-computed-at <rules-computed-at> --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>

restore

Bash

revenexx customers-segments restore \
    --id ''

Flags: --id <id>

rules-preview

Bash

revenexx customers-segments rules-preview \
    --segment-id '' \
    --conditions one two three

Flags: --segment-id <segment-id> --conditions [conditions...] --rule-match <rule-match> --target <target>

rules-recompute

Bash

revenexx customers-segments rules-recompute \
    --segment-id ''

Flags: --segment-id <segment-id> --cursor <cursor>

rules-recompute-all

Bash

revenexx customers-segments rules-recompute-all \
    --data '{ "key": "value" }'

Flags: --body <body>

trash-empty

Bash

revenexx customers-segments trash-empty

update

Bash

revenexx customers-segments update \
    --id ''

Flags: --id <id> --active [value] --code <code> --labels <labels> --position <position> --rule-match <rule-match> --rules <rules>

Was this page helpful?