---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create a suppression"
description: "`notify.suppressions.create` (POST /v1/{parent}/suppressions): Creates a suppression."
type: reference
product: email
summary: "Creates a suppression."
updated: 2026-09-28
nav: false
---

Creates a suppression.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/suppressions`
- **Scope** `notify:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [suppressions](/docs/api/suppressions)
- **Query** `suppression_id`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to create in. Required. |
| `suppression_id` | `string` | The suppression id, the final name segment; the server assigns one when empty. |
| `suppression` | `Suppression` | The suppression to create; only caller-writable fields are read. Required. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### Suppression

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/suppressions/{suppression}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `channel` | `Channel` | The channel. Required. One of `email`, `sms`, `push`, `inbox`. |
| `address` | `string` | The suppressed address, number, or device token. Required. |
| `reason` | `SuppressionReason` | Why. Required. One of `bounce`, `complaint`, `carrier_opt_out`, `unsubscribe`, `uninstalled`, `manual`. |
| `topic` | `string` | Limit the suppression to one topic; unset suppresses every topic. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/suppressions/{suppression}`. |
| `uid` | `string` | `sup_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `channel` | `Channel` | The channel. Required. One of `email`, `sms`, `push`, `inbox`. |
| `address` | `string` | The suppressed address, number, or device token. Required. |
| `reason` | `SuppressionReason` | Why. Required. One of `bounce`, `complaint`, `carrier_opt_out`, `unsubscribe`, `uninstalled`, `manual`. |
| `topic` | `string` | Limit the suppression to one topic; unset suppresses every topic. |
| `source_message` | `string` | The message whose feedback wrote it. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`PLAN_LIMIT_REACHED`](/docs/api/errors/PLAN_LIMIT_REACHED) — The plan's limit is reached.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/suppressions" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"…","channel":"email","reason":"bounce"}'
```

**TypeScript**

```ts
const response = await sylphx.notify.suppressions.create({ parent: 'orgs/acme/projects/shop/envs/production', suppression: { address: '…', channel: 'email', reason: 'bounce' } })
```

**Rust**

```rust
let mut req = sylphx::notify::CreateSuppressionRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.suppression = Some(sylphx::notify::Suppression {
    address: "…".to_string(),
    channel: sylphx::notify::Channel::Email,
    reason: sylphx::notify::SuppressionReason::Bounce,
    ..Default::default()
});
let response = sx.notify().suppressions().create(req).await?;
```

**CLI**

```bash
sylphx notify suppressions create --parent orgs/acme/projects/shop/envs/production --channel email --address … --reason bounce
```

**MCP**

```json
{ "method_id": "notify.suppressions.create", "args": {"parent":"orgs/acme/projects/shop/envs/production","suppression":{"address":"…","channel":"email","reason":"bounce"}} }
```