canvas account-notifications
canvas account-notifications¶
Manage Canvas account notifications
Synopsis¶
Manage account-wide notifications in Canvas.
Account notifications are announcements displayed to users when they log in. They can be targeted to specific user roles and scheduled for specific time periods.
Examples:
canvas account-notifications list 1
canvas account-notifications get 1 5
canvas account-notifications create 1 --subject "Maintenance" --message "System down" --start-at 2026-01-01 --end-at 2026-01-02
canvas account-notifications delete 1 5
Options¶
Options inherited from parent commands¶
--as-user int Masquerade as another user (admin feature, requires permission)
--columns strings Select specific columns to display (comma-separated)
--config string config file (default is $HOME/.canvas-cli/config.yaml)
--dry-run Print curl commands instead of executing requests
--filter string Filter results by text (case-insensitive substring match)
--instance string Canvas instance URL (overrides config)
--limit int Limit number of results for list operations (0 = unlimited)
--no-cache Disable caching of API responses
-o, --output string Output format: table, json, yaml, csv (default "table")
--quiet Suppress informational messages, only output data and errors
--show-token Show actual token in dry-run output (default: redacted)
--sort string Sort results by field (prefix with - for descending, e.g., -name)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas - Canvas LMS CLI - Interact with Canvas from the command line
- canvas account-notifications create - Create a new account notification
- canvas account-notifications delete - Delete an account notification
- canvas account-notifications get - Get a specific account notification
- canvas account-notifications list - List account notifications
- canvas account-notifications update - Update an account notification