Add a competitor brand to the watchlist
POST
/v1/email/competitive/watchlist/brands
// Requires Insights preview access for the organization.
const matches = await bird.email.competitive.brands.search({ q: "Everlane" });
const match = matches.data.find((brand) => brand.name === "Everlane");
if (!match) throw new Error("No exact Everlane match");
const entry = await bird.email.competitive.watchlist.brands.create({ brand_id: match.brand_id });
console.log(entry.id);# Requires Insights preview access for the organization.
matches = client.email.competitive.brands.search(q="Everlane")
match = next((brand for brand in matches.data if brand.name == "Everlane"), None)
if match is None:
raise ValueError("No exact Everlane match")
entry = client.email.competitive.watchlist.brands.create(brand_id=match.brand_id)
print(entry.id)// Requires Insights preview access for the organization.
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
matches, err := client.Email.Competitive.Brands.Search(ctx, bird.EmailCompetitiveBrandsSearchParams{Q: "Everlane"})
if err != nil {
log.Fatal(err)
}
brandID := ""
if matches.Data != nil {
for _, match := range *matches.Data {
if match.Name != nil && *match.Name == "Everlane" && match.BrandId != nil {
brandID = string(*match.BrandId)
break
}
}
}
if brandID == "" {
log.Fatal("No exact Everlane match")
}
report, err := client.Email.Competitive.Watchlist.Brands.Create(ctx, bird.EmailCompetitiveWatchlistBrandsCreateParams{BrandID: brandID})
if err != nil {
log.Fatal(err)
}
encoded, err := json.MarshalIndent(report, "", " ")
if err != nil {
log.Fatal(err)
}
fmt.Println(string(encoded))// Requires Insights preview access for the organization.
$matches = $bird->email->competitive->brands->search(['q' => 'Everlane']);
$brandId = null;
foreach ($matches->getData() ?? [] as $match) {
if ($match->getName() === 'Everlane') {
$brandId = $match->getBrandId();
break;
}
}
if ($brandId === null) {
throw new \RuntimeException('No exact Everlane match');
}
$params = (new \MessageBird\Wire\Model\EmailCompetitiveWatchlistBrandCreate())->setBrandId($brandId);
$entry = $bird->email->competitive->watchlist->brands->create($params);
echo $entry->getId();bird email competitive watchlist brands create 81531curl -X POST "https://us1.platform.bird.com/v1/email/competitive/watchlist/brands" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"brand_id": "81531"
}'Réponse201
{
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z",
"id": "cwb_01krdgeqcxet5s7t44vh8rt9mg",
"brand_id": "81531",
"name": "Everlane",
"industry": "DTC Apparel",
"sending_domains": [
"everlane.com"
]
}
Adds a brand to the workspace's watchlist so its figures appear next to your
own. Pass a brand_id from a brand search.
Adding a brand records the one domain the panel sees the most of its mail
from, and every figure reported for the brand describes that domain. A brand
that mails from several domains therefore reports less than its full volume.
A brand the panel has never seen send cannot be measured at all and is
refused.
How many brands can be watched is capped per organization, counted across
every workspace it owns, so the same competitor watched from two workspaces
uses two of the allowance.
API-key, OAuth, and service-account calls require Insights preview access for your organization.
Corps de la requête
brand_id
string
obligatoire
Identifier of the brand in the panel's catalog, used to add it to the watchlist. It is a string for the same reason a campaign id is: the values are wide enough that a client storing every number as a floating point value would round them, and a rounded identifier matches no brand at all.
Contenu de la réponse
created_at
string
obligatoire
updated_at
string
obligatoire
id
string
obligatoire
The watchlist entry.
brand_id
string
obligatoire
name
string
obligatoire
The brand's name when it was added. It is kept as it was so the row still reads correctly if the brand is later renamed or stops being tracked.
industry
nullable string
obligatoire
The brand's industry when it was added, or null when the brand is not classified.
sending_domains
array of string
obligatoire
The domains this brand's figures describe. Always one domain today, chosen as the one the panel sees the most of its mail from.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.
Comprendre le conceptShould I use a Bird SDK or call the API directly?Suivre le parcours d'apprentissageBuild your first integrationGuide d'implémentationSend your first email
Obtenir un guide d'implémentation