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
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}. |
uid | string | rcp_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
external_key | string | The customer's own id for this user, for example an Auth end user name. |
email_addresses | string[] | Email addresses, first is preferred. |
phone_numbers | string[] | E.164 phone numbers, first is preferred. |
devices | PushDevice[] | Redacted push-device receipts. Use registerPushDevice and unregisterPushDevice; create/update never replace this array. Output only. |
language_code | string | BCP 47 language for templates; default the environment's. |
time_zone | string | IANA time zone for quiet hours and digests. |
test | bool | A 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a recipient. |
GET | list | Lists recipients. |
POST | create | Creates a recipient. |
PATCH | update | Updates a recipient. |
POST | register_push_device | Atomically registers or renews one Web Push subscription. Other devices remain registered. The sender and recipient must share an environment. |
POST | unregister_push_device | Unregisters only the device identified by the registration receipt. A missing registration is already unregistered and succeeds. |
DELETE | delete | Deletes 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