Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Preferences
A Preference is a recipient's choice for one topic: which channels may carry it.
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 | Gets a preference. |
GET | list | Lists preferences. |
PATCH | update | Updates a preference. |
DELETE | 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
#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
#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
#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