---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Recipients"
description: "The `recipients` collection of Sylphx Notify: A Recipient is one of a customer's users, across channels: email addresses, phone numbers, and device tokens."
type: reference
product: notifications
summary: "A Recipient is one of a customer's users, across channels: email addresses, phone numbers, and device tokens."
updated: 2026-09-28
order: 900
---

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[]` | Push devices. |
| `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`](/docs/api/recipients#get) | Gets a recipient. |
| `GET` | [`list`](/docs/api/recipients#list) | Lists recipients. |
| `POST` | [`create`](/docs/api/recipients#create) | Creates a recipient. |
| `PATCH` | [`update`](/docs/api/recipients#update) | Updates a recipient. |
| `DELETE` | [`delete`](/docs/api/recipients#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](/docs/api/recipients/get)

## 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](/docs/api/recipients/list)

## 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](/docs/api/recipients/create)

## 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](/docs/api/recipients/update)

## 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](/docs/api/recipients/delete)