Update automatic seeding settings
/v1/email/inbox-insights/automatic-seeding// Requires inbox_insights:write permission in the target workspace.
const current = await bird.email.seeding.settings.get();
const settings = await bird.email.seeding.settings.update({
expected_revision: current.revision,
enabled: true,
list_type: "private",
engagement_profile: "all",
regions: ["North America - US"],
});
console.log(settings.enabled, settings.revision);# Requires inbox_insights:write permission in the target workspace.
current = client.email.seeding.settings.get()
settings = client.email.seeding.settings.update(
expected_revision=current.revision,
enabled=True,
list_type="private",
engagement_profile="all",
regions=["North America - US"],
)
print(settings.model_dump_json())// Requires inbox_insights:write permission in the target workspace.
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
current, err := client.Email.Seeding.Settings.Get(ctx)
if err != nil {
log.Fatal(err)
}
settings, err := client.Email.Seeding.Settings.Update(ctx, bird.EmailSeedingSettingsUpdateParams{
ExpectedRevision: int(current.Revision),
Enabled: bird.Bool(true),
ListType: bird.Ptr(bird.EmailInboxInsightsSeedListTypePrivate),
EngagementProfile: bird.Ptr(bird.EmailInboxInsightsSeedEngagementProfileAll),
Regions: []string{"North America - US"},
})
if err != nil {
log.Fatal(err)
}
fmt.Println(settings)// Requires inbox_insights:write permission in the target workspace.
$current = $bird->email->seeding->settings->get();
$params = (new \MessageBird\Wire\Model\AutomaticSeedingSettingsUpdate())
->setExpectedRevision($current->getRevision())
->setEnabled(true)
->setListType('private')
->setEngagementProfile('all')
->setRegions(['North America - US']);
$settings = $bird->email->seeding->settings->update($params);
var_dump($settings);bird email seeding settings update \
--enabled=false \
--engagement-profile all \
--expected-revision 0 \
--list-type private \
--yescurl -X PATCH "https://us1.platform.bird.com/v1/email/inbox-insights/automatic-seeding" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"expected_revision": 0,
"enabled": false,
"list_type": "private",
"engagement_profile": "all"
}'{
"revision": 3,
"trigger_address": "4f9a2c7e1b8d4a60935ce7f2b1d0a8c3@seeds.bird.com",
"enabled": true,
"list_type": "private",
"engagement_profile": "all",
"regions": [
"North America - US"
]
}
Replace settings at the expected revision; omitted selections clear the saved values. Disabling enabled settings permanently stops ungranted copies in existing runs; re-enabling does not resume them. Already granted copies may still send. Use revision zero for initial setup; the first successful update creates a trigger address. A stale revision returns 409 without changing settings. Where automatic seeding is active for the workspace, enabling it lets a send to the trigger address start a seed run, which uses seed-test and email-send allowance.
Request Payload
expected_revisionRevision from the latest settings read, or zero for initial setup.
enabledSaved automatic-seeding preference.
list_typeWhich 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.
Possible values (may grow over time): private, public, exclusive
engagement_profileWhich 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.
Possible values (may grow over time): all, engaging, non_engaging
regionsRegions to place seeds in. Use regions[].value exactly as returned by GET /v1/email/inbox-insights/seed-tests/configuration for the sending domain your examples come from. Whitespace-only names are rejected, but names are not checked against that list when saved; a name it does not offer makes a later run end with selection_unavailable.
Response Payload
revisionCurrent settings revision. Supply it when updating settings. Initialize settings before rotating the trigger address.
trigger_addressWorkspace trigger address for seeding examples. Absent before the first settings update. Using it requires authenticated sending access to this workspace; the address itself grants no access.
enabledSaved automatic-seeding preference.
list_typeWhich 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.
Possible values (may grow over time): private, public, exclusive
engagement_profileWhich 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.
Possible values (may grow over time): all, engaging, non_engaging
regionsSaved regions to place seeds in, as regions[].value names from GET /v1/email/inbox-insights/seed-tests/configuration. They are not checked against that list when saved.
Related resources
Continue with the documentation, guides and examples for this topic.