Sign inGet Started

Get automatic seeding settings

GET
/v1/email/inbox-insights/automatic-seeding
// Requires inbox_insights:read permission in the target workspace.
const settings = await bird.email.seeding.settings.get();
console.log(settings.enabled, settings.revision, settings.trigger_address);
Antwort200
{
  "revision": 3,
  "trigger_address": "4f9a2c7e1b8d4a60935ce7f2b1d0a8c3@seeds.bird.com",
  "enabled": true,
  "list_type": "private",
  "engagement_profile": "all",
  "regions": [
    "North America - US"
  ]
}

Read settings and the trigger address for this workspace. Requires Inbox Insights read permission. Before initial setup, the revision is zero and the trigger address is absent.

Antwort-Payload

revision
integer
erforderlich

Current settings revision. Supply it when updating settings. Initialize settings before rotating the trigger address.

trigger_address
string

Workspace 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.

enabled
boolean
erforderlich

Saved automatic-seeding preference.

list_type
string

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.

Possible values (may grow over time): private, public, exclusive

engagement_profile
string

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.

Possible values (may grow over time): all, engaging, non_engaging

regions
array of string

Saved 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.

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.