bird sms suppressions add

Usage

Code example

bird sms suppressions add [flags]

Description

Create an SMS suppression

Stop one of your senders from messaging one subscriber. Covers that sender only; your other senders keep reaching them.

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

# the body it prints:

Code example

{
  "destination": "+15550001234",
  "originator": "+15557654321"
}

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
--destination	The subscriber to stop messaging, in E.164 format. (required; or in --body-file)
--originator	The sender to stop. Your other senders keep reaching this subscriber, so stopping every one of them means one call per sender. (required; or in --body-file)
--response-schema	Print the fields this command returns, then exit

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

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideSending your first SMS Understand the conceptWhat does SMS mean?Explore the capabilitySMS Follow the learning pathBuild your first integration

Try the practice and get an implementation brief