Customers

Generated from the CLI command contract. Do not edit this page manually.

`nimbu customers`

Manage customers

`nimbu customers config`

Copy or diff customer customizations

`nimbu customers config copy`

Copy customer customizations between sites

Flags

Flag	Required	Description
`--from`	yes	Source site
`--to`	yes	Target site
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host

`nimbu customers config diff`

Diff customer customizations between sites

Flags

Flag	Required	Description
`--from`	yes	Source site
`--to`	yes	Target site
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host

`nimbu customers copy`

Copy customers between sites

Flags

Flag	Required	Default	Description
`--from`	yes		Source site
`--to`	yes		Target site
`--from-host`	no		Source API base URL or host
`--to-host`	no		Target API base URL or host
`--query`	no		Raw query string to append to the source customer list
`--where`	no		Where expression for source customer selection
`--per-page`	no		Items per page
`--upsert`	no	`email`	Comma-separated upsert fields
`--password-length`	no	`12`	Generated password length for newly created customers
`--allow-errors`	no		Continue on item-level validation errors

`nimbu customers count`

Count customers

Flags

Flag	Required	Default	Description
`--locale`	no		Filter by locale
`--filters`	no		Filter by key=value, repeatable

`nimbu customers create`

Create a customer

Arguments

Name	Required	Description
`assignments`	no	Inline assignments (e.g. email=a@b.com, first_name=Ana)

Flags

Flag	Required	Default	Description
`--file`	no		Read customer JSON from file (use - for stdin)

`nimbu customers delete`

Delete a customer

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID or email

`nimbu customers fields`

Show customer field schema

`nimbu customers get`

Get customer by ID or email

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID or email

`nimbu customers list`

List customers

Flags

Flag	Required	Default	Description
`--fields`	no		Comma-separated fields to return
`--locale`	no		Filter by locale
`--include`	no		Include related resources
`--sort`	no		Sort by field, e.g. field or field:desc
`--filters`	no		Filter by key=value, repeatable
`--all`	no		Fetch all pages
`--page`	no	`1`	Page number
`--per-page`	no	`25`	Items per page

`nimbu customers resend-confirmation`

Resend confirmation instructions

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID or email

`nimbu customers reset-password`

Send password reset instructions

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID or email

`nimbu customers roles`

Manage customer roles

`nimbu customers roles add`

Add directly assigned customer roles

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID, slug, or email
`--role`	yes		Role ID or name, repeatable

`nimbu customers roles list`

List directly assigned customer roles

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID, slug, or email

`nimbu customers roles remove`

Remove directly assigned customer roles

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID, slug, or email
`--role`	yes		Role ID or name, repeatable

`nimbu customers roles set`

Replace directly assigned customer roles

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID, slug, or email
`--role`	yes		Role ID or name, repeatable

`nimbu customers update`

Update a customer

Arguments

Name	Required	Description
`assignments`	no	Inline assignments (e.g. first_name=Ana, phone=+32...)

Flags

Flag	Required	Default	Description
`--customer`	yes		Customer ID or email
`--file`	no		Read customer JSON from file (use - for stdin)

On this page