canvas conversations
canvas conversations¶
Manage Canvas conversations (inbox)
Synopsis¶
Manage Canvas conversations and messages.
Conversations are Canvas's internal messaging system for communication between users within courses and the institution.
Examples:
canvas conversations list
canvas conversations list --scope unread
canvas conversations get 123
canvas conversations create --recipients 456,789 --subject "Hello" --body "Message content"
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")
--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 conversations add-recipients - Add recipients to a conversation
- canvas conversations archive - Archive a conversation
- canvas conversations create - Create a new conversation
- canvas conversations delete - Delete a conversation
- canvas conversations get - Get conversation details
- canvas conversations list - List conversations
- canvas conversations mark-all-read - Mark all conversations as read
- canvas conversations mark-read - Mark a conversation as read
- canvas conversations reply - Reply to a conversation
- canvas conversations star - Star a conversation
- canvas conversations unarchive - Unarchive a conversation
- canvas conversations unread-count - Get unread conversation count
- canvas conversations unstar - Unstar a conversation