Rotate the automatic seeding address
/v1/email/inbox-insights/automatic-seeding/rotate// Requires inbox_insights:write permission in the target workspace.
const current = await bird.email.seeding.settings.get();
const settings = await bird.email.seeding.address.rotate({
expected_revision: current.revision,
});
console.log(settings.trigger_address);# Requires inbox_insights:write permission in the target workspace.
current = client.email.seeding.settings.get()
settings = client.email.seeding.address.rotate(expected_revision=current.revision)
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.Address.Rotate(ctx, bird.EmailSeedingAddressRotateParams{ExpectedRevision: int(current.Revision)})
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\AutomaticSeedingRotate())
->setExpectedRevision($current->getRevision());
$settings = $bird->email->seeding->address->rotate($params);
var_dump($settings->getTriggerAddress());bird email seeding address rotate --expected-revision 1 --yescurl -X POST "https://us1.platform.bird.com/v1/email/inbox-insights/automatic-seeding/rotate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"expected_revision": 1
}'{
"revision": 3,
"trigger_address": "4f9a2c7e1b8d4a60935ce7f2b1d0a8c3@seeds.bird.com",
"enabled": true,
"list_type": "private",
"engagement_profile": "all",
"regions": [
"North America - US"
]
}
Replace the trigger address and permanently stop ungranted copies in existing runs. Granted copies may still send. Initialize settings with PATCH /v1/email/inbox-insights/automatic-seeding first; otherwise rotation returns 404. Use the same idempotency key and expected revision after a lost response; a stale revision returns 409 without rotating again.
Anfrage-Nutzlast
expected_revisionRevision from the latest settings read after initial setup. Revision zero from an unconfigured workspace cannot be used to rotate an address.
Antwort-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.
Verwandte Ressourcen
Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.