---
title: "bird email seeding settings update"
description: "Update automatic seeding settings"
canonical: "https://bird.com/docs/cli/reference/email-seeding-settings-update"
---

# `bird email seeding settings update`

## Usage

```bash
bird email seeding settings update [flags]
```

## Description

Update automatic seeding settings

Replace complete settings at the expected revision; omitted selections are cleared.
Revision zero initializes settings, and enabling requires complete selections.
Disabling permanently stops existing runs' ungranted copies; re-enabling does not resume
them. Already granted copies may still send. The response includes the workspace trigger
address. While seeding is enabled, an eligible send to the trigger address starts a seed
run that uses seed-test and email-send allowance.

Build the request from flags, a JSON AutomaticSeedingSettingsUpdate body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.

Browser confirmation: the review link goes to stderr, not stdout, as next[].url
in a JSON line that also carries confirmation\_id. The command then waits and
prints the result on stdout; --confirmation-id waits on an existing one.

This is destructive and cannot be undone; pass --yes to confirm.

## Procedure

Step 3 of 3 of "Configure Automatic Email Seeding". Previous: bird email inbox-insights seed-tests configuration get.

## Examples

```bash
# print the body shape (no credentials needed)
bird email seeding settings update --example

# the body it prints:
```

```json
{
  "enabled": false,
  "engagement_profile": "all",
  "expected_revision": 0,
  "list_type": "private"
}
```

## Options

#### Request

| Name                | Description                                                  |
| ------------------- | ------------------------------------------------------------ |
| `--body-file`       | Read the JSON request body from this file; "-" reads stdin   |
| `--example`         | Print a complete example request body, then exit             |
| `--dry-run`         | Print the resolved request without sending it, then exit     |
| `--idempotency-key` | Deduplication key; a retry with the same key won't act twice |

#### Safety

| Name    | Description                                          |
| ------- | ---------------------------------------------------- |
| `--yes` | Confirm the action (required; the CLI never prompts) |

#### Options

| Name                      | Description                                                                                                                                                                                                                                                                                                                       |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--expected-revision <n>` | Revision from the latest settings read, or zero for initial setup. (required; or in --body-file)                                                                                                                                                                                                                                  |
| `--enabled`               | Saved automatic-seeding preference. (required; or in --body-file)                                                                                                                                                                                                                                                                 |
| `--list-type`             | Which pool of seed addresses a test uses. Which pools an account can use depends on what has been provisioned for it, so read the usable set from the seed-test options rather than assuming these are the only values. Known values: private, public, exclusive (others may exist).                                              |
| `--engagement-profile`    | Which engagement behaviour the seed addresses simulate. all mixes engaged and dormant seeds, which is what makes an engagement split measurable; single-cohort profiles exist too, and the usable set comes from the seed-test options rather than from this list. Known values: all, engaging, non\_engaging (others may exist). |
| `--regions <value>…`      | Saved region preferences. Whitespace-only names are rejected; available seed regions are not checked.                                                                                                                                                                                                                             |
| `--response-schema`       | Print the fields this command returns, then exit                                                                                                                                                                                                                                                                                  |
| `--confirmation-id`       | Wait for an existing confirmation of this exact request                                                                                                                                                                                                                                                                           |

## Related

| Name                                                                                | Description                    |
| ----------------------------------------------------------------------------------- | ------------------------------ |
| [`bird email seeding settings get`](/docs/cli/reference/email-seeding-settings-get) | Get automatic seeding settings |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)
