CLICommand reference
Announcements
Generated reference for nimbu announcements
Generated from the CLI command contract. Do not edit this page manually.
nimbu announcements
Manage platform announcements
nimbu announcements create
Create an announcement
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline announcement field assignments |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--file | no | Read JSON from file (use - for stdin) |
nimbu announcements delete
Delete an announcement (requires --force)
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--id | yes | Announcement ID |
nimbu announcements get
Get an announcement
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--id | yes | Announcement ID |
nimbu announcements list
List announcements
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Filter by locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--all | no | Fetch all pages | |
--page | no | 1 | Page number |
--per-page | no | 25 | Items per page |
nimbu announcements update
Update an announcement
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline announcement field assignments |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--id | yes | Announcement ID | |
--file | no | Read JSON from file (use - for stdin) |