bird whatsapp suppressions add

Usage

Code example

bird whatsapp suppressions add [flags]

Description

Create a WhatsApp suppression

Record a WhatsApp address on the workspace suppression list.

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

# the body it prints:

Code example

{
  "address": "+5511977670804"
}

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
--address	WhatsApp address to suppress. For a phone number, supply canonical E.164 with a leading plus sign, such as +5511977670804. A value that is not a valid phone number returns a 422. (required; or in --body-file)
--waba	Limit the suppression to messages sent from this WhatsApp Business Account, identified by its WhatsApp-issued account ID. Omit it to block the address for the whole workspace, whichever account sends.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird whatsapp suppressions get	Get a WhatsApp suppression
bird whatsapp suppressions list	List WhatsApp suppressions
bird whatsapp suppressions remove	End a WhatsApp 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