bird email suppressions add
Usage
Codevoorbeeld
bird email suppressions add [flags]Description
Create an email suppression
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
Codevoorbeeld
# print the body shape (no credentials needed)
bird email suppressions add --example
# the body it prints:Codevoorbeeld
{
"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 |
|---|---|
| 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 |
Related
| 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 |
Gerelateerde bronnen
Ga verder met de documentatie, gidsen en voorbeelden voor dit onderwerp. De bronnen zijn in het Engels.
Begrijp het conceptShould I use a Bird SDK or call the API directly?Volg het leerpadBuild your first integrationImplementatiegidsSend your first email
Ontvang een implementatieoverzicht