Sign inGet Started

bird whatsapp suppressions add

Usage

Code example
bird whatsapp suppressions add [flags]

Description

Create a WhatsApp suppression

Stop messages to one WhatsApp address, for one business account or for the whole workspace.

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

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--addressThe WhatsApp address to stop messaging. 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 or business-scoped user ID returns 422. (required; or in --body-file)
--wabaThe WhatsApp Business Account to stop, identified by its WhatsApp-issued account ID or by the waa_ ID Bird gives it. Either form resolves to the same account, and the suppression stores and returns the WhatsApp-issued one. Omit it to stop the address for the whole workspace, whichever account sends. An account that is not one of yours returns 404 on a single create, and its row reports error in a bulk create.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp suppressions getGet a WhatsApp suppression
bird whatsapp suppressions listList WhatsApp suppressions
bird whatsapp suppressions removeEnd a WhatsApp suppression

Continue with the documentation, guides and examples for this topic.