Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

sylphx notify suppressions

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

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

#get

Gets a suppression.

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

CLI

Shell
sylphx notify suppressions get orgs/acme/projects/shop/envs/production/suppressions/suppression

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

#list

Lists suppressions.

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

CLI

Shell
sylphx notify suppressions list orgs/acme/projects/shop/envs/production

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

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels and filterable fields.
--order-bystringAIP-132 ordering over filterable fields.

#create

Creates a suppression.

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

CLI

Shell
sylphx notify suppressions create --parent orgs/acme/projects/shop/envs/production --channel email --address … --reason bounce

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

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--channelenumThe channel. Required. One of email, sms, push, inbox.
--addressstringThe suppressed address, number, or device token. Required.
--reasonenumWhy. Required. One of bounce, complaint, carrier_opt_out, unsubscribe, uninstalled, manual.
--topicstringLimit the suppression to one topic; unset suppresses every topic.
--dry-runboolValidate and print the result without writing (validate_only).

#delete

Deletes a suppression.

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

CLI

Shell
sylphx notify suppressions delete orgs/acme/projects/shop/envs/production/suppressions/suppression --yes

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

Flags

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--allow-missingboolSucceed when the suppression does not exist.
--dry-runboolValidate and print the result without writing (validate_only).
--yesboolDo not ask before this destructive call.