Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
sylphx notify inbox_items
Every sylphx notify inbox_items command: its argument, its flags and a run line.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
The inbox_items commands of Sylphx Notify, as the CLI spells them: the same
calls as the inbox_items API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets an inbox item.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify inbox-items get orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-itemGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item · scope notify:read · effect read · Request, response and examples
#list
Lists inbox items.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx notify inbox-items list orgs/acme/projects/shop/envs/production/recipients/recipientGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items · 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. |
#mark-read
Marks an inbox item read.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify inbox-items mark-read orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-itemPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markRead · scope notify:write · effect write · Request, response and examples
#mark-unread
Marks an inbox item unread.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify inbox-items mark-unread orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-itemPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markUnread · scope notify:write · effect write · Request, response and examples
#archive
Archives an inbox item.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify inbox-items archive orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-itemPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:archive · scope notify:write · effect write · Request, response and examples