---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx notify messages"
description: "The sylphx notify messages commands of Sylphx Notify: every verb, with its argument, its flags and a run line."
type: reference
product: email
summary: "Every sylphx notify messages command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `messages` commands of Sylphx Notify, as the CLI spells them: the same
calls as [the `messages` API page](/docs/api/messages), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a message.

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

**CLI**

```bash
sylphx notify messages get orgs/acme/projects/shop/envs/production/messages/message
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/messages/message` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/messages/get)

## list

Lists messages.

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

**CLI**

```bash
sylphx notify messages list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/messages` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/messages/list)

**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. |

## send

Sends a Message.

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

**CLI**

```bash
sylphx notify messages send --parent orgs/acme/projects/shop/envs/production --recipient … --topic …
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/messages` · scope `notify:send` · effect `write` · [Request, response and examples](/docs/api/messages/create)

**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. |
| `--recipient` | `string` | The recipient. Required. |
| `--topic` | `string` | The topic preferences are checked against, for example `billing`. Required. |
| `--template` | `string` | The template to render; required unless `mailbox` and `content` are set. |
| `--data` | `json` | Template variables. |
| `--channels` | `enum` | Restrict to these channels, in fallback order; empty uses the recipient's preferences. Repeat the flag for each value. One of `email`, `sms`, `push`, `inbox`. |
| `--send-time` | `timestamp` | Send no earlier than this. |
| `--delivery-deadline-time` | `timestamp` | Deliver no later than this; a delivery still open then fails with `expired`. Unset retries for up to a day. The message record is kept. |
| `--mailbox` | `string` | Send as this mailbox (its address, display name and, for a connected mailbox, its own SMTP) instead of a verified Email Domain. |
| `--content.subject` | `string` | The subject. |
| `--content.text-body` | `string` | The plain-text body. |
| `--content.html-body` | `string` | The HTML body. |
| `--parent-message-id` | `string` | In-Reply-To: the Message-ID this answers, without angle brackets. |
| `--references` | `string` | The thread's Message-IDs, oldest first, without angle brackets. Repeat the flag for each value. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## cancel

Cancels a Message whose deliveries have not been handed off.

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

**CLI**

```bash
sylphx notify messages cancel orgs/acme/projects/shop/envs/production/messages/message --yes
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/messages/message:cancel` · scope `notify:send` · effect `destructive` · [Request, response and examples](/docs/api/messages/cancel)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--yes` | `bool` | Do not ask before this destructive call. |