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 templates

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

Checked 2026-09-28

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

#get

Gets a template.

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

CLI

Shell

sylphx notify templates get orgs/acme/projects/shop/envs/production/templates/template

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

#list

Lists templates.

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

CLI

Shell

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

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates · 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 template.

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

CLI

Shell

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

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates · 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.
`--spec.email.sender-address`	`string`	The From address; its domain is a verified Email Domain.
`--spec.email.subject`	`string`	The subject.
`--spec.email.html-body`	`string`	The HTML body.
`--spec.email.text-body`	`string`	The plain-text body.
`--spec.email.sender-name`	`string`	The From display name, for example the app's name.
`--spec.sms.sender`	`string`	The SMS Sender.
`--spec.sms.body`	`string`	The body.
`--spec.push.title`	`string`	The title.
`--spec.push.body`	`string`	The body.
`--spec.push.data`	`json`	Data delivered with the notification.
`--spec.inbox.title`	`string`	The title.
`--spec.inbox.body`	`string`	The body.
`--spec.inbox.action-uri`	`string`	Where the item links.
`--spec.send-limit.min-interval`	`duration`	At least this long between two messages to one recipient.
`--spec.send-limit.max-per-hour`	`int`	At most this many messages to one recipient in any hour; 0 is no limit.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates a template.

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

CLI

Shell

sylphx notify templates update orgs/acme/projects/shop/envs/production/templates/template

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates/template · 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.
`--spec.email.sender-address`	`string`	The From address; its domain is a verified Email Domain.
`--spec.email.subject`	`string`	The subject.
`--spec.email.html-body`	`string`	The HTML body.
`--spec.email.text-body`	`string`	The plain-text body.
`--spec.email.sender-name`	`string`	The From display name, for example the app's name.
`--spec.sms.sender`	`string`	The SMS Sender.
`--spec.sms.body`	`string`	The body.
`--spec.push.title`	`string`	The title.
`--spec.push.body`	`string`	The body.
`--spec.push.data`	`json`	Data delivered with the notification.
`--spec.inbox.title`	`string`	The title.
`--spec.inbox.body`	`string`	The body.
`--spec.inbox.action-uri`	`string`	Where the item links.
`--spec.send-limit.min-interval`	`duration`	At least this long between two messages to one recipient.
`--spec.send-limit.max-per-hour`	`int`	At most this many messages to one recipient in any hour; 0 is no limit.
`--allow-missing`	`bool`	Create the template when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes a template.

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

CLI

Shell

sylphx notify templates delete orgs/acme/projects/shop/envs/production/templates/template --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates/template · 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 template does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--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