---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Preferences"
description: "The `preferences` collection of Sylphx Notify: A Preference is a recipient's choice for one topic: which channels may carry it."
type: reference
product: notifications
summary: "A Preference is a recipient's choice for one topic: which channels may carry it."
updated: 2026-09-28
order: 900
---

A Preference is a recipient's choice for one topic: which channels may carry it. Admission honors it, and unsubscribe links write it. The id is the topic.

**Service** Sylphx Notify · **Resource type** `notify.sylphx.com/Preference` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/preferences/{preference}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/preferences/{preference}`. |
| `uid` | `string` | `prf_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `channels` | `Channel[]` | Channels the topic may use; empty mutes the topic. One of `email`, `sms`, `push`, `inbox`. |
| `digest_interval` | `duration` | Batch this topic into a digest at most this often; unset sends each message. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/preferences#get) | Gets a preference. |
| `GET` | [`list`](/docs/api/preferences#list) | Lists preferences. |
| `PATCH` | [`update`](/docs/api/preferences#update) | Updates a preference. |
| `DELETE` | [`delete`](/docs/api/preferences#delete) | Deletes a preference. |

## get

Gets a 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.

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

## update

Updates a 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)

## delete

Deletes a preference.

`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)