bird email suppressions add

Usage

Code example

bird email suppressions add [flags]

Add an email address to the workspace suppression list to stop delivery to it. The record is created with reason manual, which blocks every message category, transactional mail included. Adding is idempotent, so an address that already carries a manual suppression comes back unchanged.

Build the request from flags, a JSON SuppressionCreate 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 suppressions add --example

# the body it prints:

Code example

{
  "email": "jane@example.com"
}

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
--email	The address to stop sending to. Normalized before storage and matching: lowercased and trimmed of surrounding whitespace. (required; or in --body-file)
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email suppressions get	Get an email suppression
bird email suppressions list	List email suppressions
bird email suppressions remove	Delete an email suppression

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