bird email competitive watchlist brands create

Usage

Code example

bird email competitive watchlist brands create <brand-id> [flags]

Add a brand using the panel brand_id returned by brand search. The response id identifies the new workspace watchlist entry for reads and removal. Each entry uses one place in the organization-wide allowance and tracks the brand's highest-volume sending domain. Reuse an idempotency key when retrying the same addition.

API-key, OAuth, and service-account calls require Insights preview access for your organization.

Build the request from the <brand_id> argument, a JSON EmailCompetitiveWatchlistBrandCreate body via --body-file ("-" reads stdin), or both — an inline value 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.

Examples

Code example

# print the body shape (no credentials needed)
bird email competitive watchlist brands create --example

# the body it prints:

Code example

{
  "brand_id": "81531"
}

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

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email competitive watchlist brands delete	Remove a competitor brand from the watchlist
bird email competitive watchlist brands get	Get a watched brand's figures
bird email competitive watchlist brands send-time	Get when a watched brand sends

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integration Implementation guideSend your first email

Get an implementation brief