Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

get
list
create
update
delete

Reference

sylphx notify recipients

Every sylphx notify recipients command: its argument, its flags and a run line.

Checked 2026-09-28

The recipients commands of Sylphx Notify, as the CLI spells them: the same calls as the recipients API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

Gets a recipient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx notify recipients get orgs/acme/projects/shop/envs/production/recipients/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.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell

sylphx notify recipients list orgs/acme/projects/shop/envs/production

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

Flags

Flag	Type	What it does
`--page-size`	`int`	At most this many; default 50, clamped to 1000.
`--page-token`	`string`	`next_page_token` of the previous page.
`--filter`	`string`	AIP-160 filter over labels and filterable fields.
`--order-by`	`string`	AIP-132 ordering over filterable fields.

#create

Creates a recipient.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell

sylphx notify recipients create --parent orgs/acme/projects/shop/envs/production

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

Flags

Flag	Type	What it does
`--parent`	`string`	The parent to create in; defaults to the linked project or the key's scope.
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--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. Repeat the flag for each value.
`--phone-numbers`	`string`	E.164 phone numbers, first is preferred. Repeat the flag for each value.
`--devices`	`json`	Push devices. Repeat the flag for each value.
`--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.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates a recipient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx notify recipients update orgs/acme/projects/shop/envs/production/recipients/recipient

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

Flags

Flag	Type	What it does
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--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. Repeat the flag for each value.
`--phone-numbers`	`string`	E.164 phone numbers, first is preferred. Repeat the flag for each value.
`--devices`	`json`	Push devices. Repeat the flag for each value.
`--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.
`--allow-missing`	`bool`	Create the recipient when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes a recipient.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx notify recipients delete orgs/acme/projects/shop/envs/production/recipients/recipient --yes

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

Flags

Flag	Type	What it does
`--etag`	`string`	Delete only if the current etag matches.
`--allow-missing`	`bool`	Succeed when the recipient does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--force`	`bool`	Also delete the recipient's preferences and inbox items.
`--yes`	`bool`	Do not ask before this destructive call.

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links