Skip to content
Console
On this page

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

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/preferences/{preference}.
uidstringprf_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
channelsChannel[]Channels the topic may use; empty mutes the topic. One of email, sms, push, inbox.
digest_intervaldurationBatch 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.

MethodCallWhat it does
GETgetGets a preference.
GETlistLists preferences.
PATCHupdateUpdates a preference.
DELETEdeleteDeletes 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