email-competitive

Add a competitor brand to the watchlist

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.

post/v1/email/competitive/watchlist/brands

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/competitive/watchlist/brands
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

brand_idstring required

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.

Example request

{
  "brand_id": "81531"
}

Response

The brand was added to the watchlist.

created_atstring date-time required
updated_atstring date-time required
idstring required
brand_idstring required

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.

namestring required

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.

industrystring nullable required

The brand's industry when it was added, or null when the brand is not classified.

sending_domainsstring[] required

The domains this brand's figures describe. Always one domain today, chosen as the one the panel sees the most of its mail from.

Example response

{
  "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"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.