email-inbox-insights

Switch Inbox Insights on or off for a sending domain

Changes the workspace's monitoring preference for one of its verified sending domains. Enabling enrolls the domain with eDataSource before saving the preference. Disabling removes the preference without removing vendor enrollment or history. Report reads remain available for verified owned domains regardless of this setting.

A domain switched on for the first time has to be measured before it has anything to report, so its results start empty and fill in as its mail is seen. Switching off keeps everything measured so far: switching the domain back on restores it in full and takes effect immediately, rather than starting the domain over.

Setting the value it already has changes nothing and answers normally, so this is safe to repeat.

patch/v1/email/inbox-insights/domains/{sending_domain}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/inbox-insights/domains/{sending_domain}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

sending_domainstring required
Example:mail.acme.com

The sending domain to change, exactly as it appears in your sending domains. A domain that is not verified in this workspace answers not-found.

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

monitoredboolean required

Whether the workspace wants this domain monitored. Enabling enrolls it with eDataSource; disabling removes only the workspace preference and preserves vendor enrollment and measurement history. Verified ownership governs report access.

Example request

{
  "monitored": true
}

Response

The domain's Inbox Insights setting after the change.

domainstring required

The sending domain, lowercased, as it appears in your sending domains.

monitoredboolean required

Whether Inbox Insights reports on this domain. Switching it off stops the reporting and keeps the measurement history, so switching it back on restores the full history rather than starting again.

Example response

{
  "domain": "mail.acme.com",
  "monitored": true
}

Changes

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