Skip to content
Console
On this page

Recipients

A Recipient is one of a customer's users, across channels: email addresses, phone numbers, and device tokens.

A Recipient is one of a customer's users, across channels: email addresses, phone numbers, and device tokens. Dead device tokens are pruned from provider feedback.

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

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}.
uidstringrcp_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
external_keystringThe customer's own id for this user, for example an Auth end user name.
email_addressesstring[]Email addresses, first is preferred.
phone_numbersstring[]E.164 phone numbers, first is preferred.
devicesPushDevice[]Redacted push-device receipts. Use registerPushDevice and unregisterPushDevice; create/update never replace this array. Output only.
language_codestringBCP 47 language for templates; default the environment's.
time_zonestringIANA time zone for quiet hours and digests.
testboolA test recipient: its messages are rendered and captured on the Message, never delivered. An email address whose local part carries +sylphx_test is a test address whatever this says.

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 recipient.
GETlistLists recipients.
POSTcreateCreates a recipient.
PATCHupdateUpdates a recipient.
POSTregister_push_deviceAtomically registers or renews one Web Push subscription. Other devices remain registered. The sender and recipient must share an environment.
POSTunregister_push_deviceUnregisters only the device identified by the registration receipt. A missing registration is already unregistered and succeeds.
DELETEdeleteDeletes a recipient.

get

Gets a recipient.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient · scope notify:read · effect read · Request, response and examples

list

Lists recipients.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients · scope notify:read · effect read · paginated · Request, response and examples

create

Creates a recipient.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients · scope notify:write · effect write · Request, response and examples

update

Updates a recipient.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient · scope notify:write · effect write · Request, response and examples

register_push_device

Atomically registers or renews one Web Push subscription. Other devices remain registered. The sender and recipient must share an environment.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient:registerPushDevice · scope notify:write · effect write · Request, response and examples

unregister_push_device

Unregisters only the device identified by the registration receipt. A missing registration is already unregistered and succeeds.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient:unregisterPushDevice · scope notify:write · effect write · Request, response and examples

delete

Deletes a recipient.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient · scope notify:write · effect destructive · Request, response and examples