canvas comm-channels
canvas comm-channels¶
Manage communication channels
Synopsis¶
Manage communication channels for Canvas users.
Examples:
canvas comm-channels list --user-id 123
canvas comm-channels create --user-id 123 --address "user@example.com" --type email
canvas comm-channels delete --user-id 123 --channel-id 456
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 comm-channels create - Create a communication channel for a user
- canvas comm-channels delete - Delete a communication channel
- canvas comm-channels list - List communication channels for a user