Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Suppressions
A Suppression stops delivery to one address on one channel.
A Suppression stops delivery to one address on one channel. Bounces, complaints, carrier opt-outs, uninstalled devices, and unsubscribes write it; admission checks it before accepting a message.
Service Sylphx Notify · Resource type notify.sylphx.com/Suppression · Name pattern orgs/{org}/projects/{project}/envs/{env}/suppressions/{suppression} · Shape record
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/suppressions/{suppression}. |
uid | string | sup_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
channel | Channel | The channel. Required. One of email, sms, push, inbox. |
address | string | The suppressed address, number, or device token. Required. |
reason | SuppressionReason | Why. Required. One of bounce, complaint, carrier_opt_out, unsubscribe, uninstalled, manual. |
topic | string | Limit the suppression to one topic; unset suppresses every topic. |
source_message | string | The message whose feedback wrote it. Output only. |
#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 | Gets a suppression. |
GET | list | Lists suppressions. |
POST | create | Creates a suppression. |
DELETE | delete | Deletes a suppression. |
#get
Gets a 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.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/suppressions · scope notify:read · effect read · paginated · Request, response and examples
#create
Creates a suppression.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/suppressions · scope notify:write · effect write · Request, response and examples
#delete
Deletes a suppression.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/suppressions/suppression · scope notify:write · effect destructive · Request, response and examples