---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx notify preferences"
description: "The sylphx notify preferences commands of Sylphx Notify: every verb, with its argument, its flags and a run line."
type: reference
product: notifications
summary: "Every sylphx notify preferences command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `preferences` commands of Sylphx Notify, as the CLI spells them: the same
calls as [the `preferences` API page](/docs/api/preferences), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a preference.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx notify preferences get orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/preferences/get)

## list

Lists preferences.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx notify preferences list orgs/acme/projects/shop/envs/production/recipients/recipient
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/preferences/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels and filterable fields. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## update

Updates a preference.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx notify preferences update orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/preferences/update)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--channels` | `enum` | Channels the topic may use; empty mutes the topic. Repeat the flag for each value. One of `email`, `sms`, `push`, `inbox`. |
| `--digest-interval` | `duration` | Batch this topic into a digest at most this often; unset sends each message. |
| `--allow-missing` | `bool` | Create the preference when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## delete

Deletes a preference.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx notify preferences delete orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference` · scope `notify:write` · effect `destructive` · [Request, response and examples](/docs/api/preferences/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the preference does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--yes` | `bool` | Do not ask before this destructive call. |