# `bird amb suppressions create`

## Usage

```bash
bird amb suppressions create [flags]
```

## Description

Create an Apple Messages for Business suppression

Manually opens a suppression episode for a handle, blocking every outbound path to it: operator and automated replies, API sends, typing indicators, and invitations. Set `business_id` to block the handle for one brand only, or omit it to block the handle for every brand in the workspace. If the handle 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

```bash
# print the body shape (no credentials needed)
bird amb suppressions create --example

# the body it prints:
```

```json
{
  "handle": "+15551234567",
  "handle_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-id`     | Suppress the handle for this brand only. Omit or send null to block it for every brand in the workspace.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `--handle`          | 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)                                                                                                                                                                                                                                                                                                                                                                                        |
| `--handle-type`     | What kind of value handle holds. - phone\_number means handle 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 handle 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`](/docs/cli/reference/amb-suppressions-delete) | End an Apple Messages for Business suppression |
| [`bird amb suppressions get`](/docs/cli/reference/amb-suppressions-get)       | Get an Apple Messages for Business suppression |
| [`bird amb suppressions list`](/docs/cli/reference/amb-suppressions-list)     | List Apple Messages for Business suppressions  |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)