bird email inbox-insights domains update
Usage
Code example
bird email inbox-insights domains update <sending-domain> [flags]Description
Switch Inbox Insights on or off for a sending domain
Set monitored explicitly to true or false for a verified domain owned by the workspace.
Enabling enrolls the domain with eDataSource and saves the workspace preference.
Disabling removes only that preference; vendor enrollment and measurement history remain.
Reports still require verified ownership and are not gated by this preference.
Repeating the same value is safe. Reuse an idempotency key when retrying the same change.
API-key and service-account calls require Insights preview access for your organization.
Build the request from flags, a JSON EmailInboxInsightsDomainUpdate body via --body-file ("-" reads
stdin), or both — a flag 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 inbox-insights domains update --example
# the body it prints:Code example
{
"monitored": true
}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 |
|---|---|
| --monitored | 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. (required; or in --body-file) |
| --response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
| bird email inbox-insights domains list | List sending domains and their Inbox Insights status |
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 integrationImplementation guideSend your first email
Get an implementation brief