notification-recipients Commands

Manage notification-recipients

Output formatting flags (--json, --jq, and --template) are documented once in Output Formatting and are omitted from the tables below.

`bctrl notification-recipients create`

Create a notification receiver. Use BCTRL-Subaccount-Id to create it for a subaccount. Supported receiver types are email, SMS, and WhatsApp.

bctrl notification-recipients create [flags]

Flag	Description
`--headers <json>`	API headers: inline JSON, @file, or - for stdin
`--api-version <date>`	Dated API contract (default: 2026-10-03)
`--space <id-or-name>`	Select an authorized Space (BCTRL-Space)
`--subaccount-id <id>`	Effective subaccount context (BCTRL-Subaccount-Id)
`--idempotency-key <key>`	Retry key for this operation
`--body <json>`	Request body: inline JSON, @file, or - for stdin

Delete one notification receiver. Historical delivery records are kept.

bctrl notification-recipients delete <recipientId> [flags]

Flag	Description
`--headers <json>`	API headers: inline JSON, @file, or - for stdin
`--api-version <date>`	Dated API contract (default: 2026-10-03)
`--space <id-or-name>`	Select an authorized Space (BCTRL-Space)
`--subaccount-id <id>`	Effective subaccount context (BCTRL-Subaccount-Id)
`--idempotency-key <key>`	Retry key for this operation
`--yes`	Confirm this destructive operation

List notification receivers used for input requests. Use BCTRL-Subaccount-Id to scope the request to a subaccount.

bctrl notification-recipients list [flags]

Flag	Description
`--query <json>`	Query object: inline JSON, @file, or - for stdin
`--params <json>`	Alias for —query
`--cursor <value>`	Query parameter cursor
`--order <value>`	Query parameter order
`--limit <value>`	Query parameter limit
`--type <value>`	Query parameter type
`--enabled <value>`	Query parameter enabled
`--headers <json>`	API headers: inline JSON, @file, or - for stdin
`--api-version <date>`	Dated API contract (default: 2026-10-03)
`--space <id-or-name>`	Select an authorized Space (BCTRL-Space)
`--subaccount-id <id>`	Effective subaccount context (BCTRL-Subaccount-Id)

Update one notification receiver value, label, or enabled state.

bctrl notification-recipients update <recipientId> [flags]

Flag	Description
`--headers <json>`	API headers: inline JSON, @file, or - for stdin
`--api-version <date>`	Dated API contract (default: 2026-10-03)
`--space <id-or-name>`	Select an authorized Space (BCTRL-Space)
`--subaccount-id <id>`	Effective subaccount context (BCTRL-Subaccount-Id)
`--idempotency-key <key>`	Retry key for this operation
`--body <json>`	Request body: inline JSON, @file, or - for stdin