bird amb suppressions create
Usage
bird amb suppressions create [flags]Description
Create an Apple Messages for Business suppression
Manually opens a suppression episode for a address, blocking every outbound path to it: operator and automated replies, API sends, typing indicators, and invitations. Set business_account_id to block the address for one brand only, or omit it to block the address for every brand in the workspace. If the address already has an active episode with reason manual, the API returns 200 with the existing episode instead of creating a second one.
Build the request from flags, a JSON AMBSuppressionCreate 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
# print the body shape (no credentials needed)
bird amb suppressions create --example
# the body it prints:{
"address": "+15551234567",
"address_type": "phone_number"
}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 |
|---|---|
--business-account-id | Limit this manual block to one account. Omit to cover the same address across the workspace. |
--address | The phone number or opaque identifier to suppress. For a phone number, supply canonical E.164 with a leading plus sign. (required; or in --body-file) |
--address-type | What kind of value address holds. - phone_number means address is the customer's phone number. Apple's CloseSession event carries a phone number rather than an opaque identifier, so a suppression opened by a close on a conversation identified by phone number takes this kind. - opaque_user_id means address is the opaque identifier Apple assigns to the customer's conversation with the business, stable across a close and a later re-initiation. Possible values: phone_number, opaque_user_id. (required; or in --body-file) |
--response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
bird amb suppressions delete | End an Apple Messages for Business suppression |
bird amb suppressions get | Get an Apple Messages for Business suppression |
bird amb suppressions list | List Apple Messages for Business suppressions |
Risorse correlate
Continua con la documentazione, le guide e gli esempi per questo argomento.