canvas conversations create
canvas conversations create¶
Create a new conversation
Synopsis¶
Create a new conversation with one or more recipients.
Examples:
canvas conversations create --recipients 123,456 --subject "Hello" --body "Message text"
canvas conversations create --recipients 123 --body "Quick message"
canvas conversations create --recipients course_123 --subject "Announcement" --body "Message" --group
Options¶
--attachment-ids int64Slice Attachment IDs (default [])
--body string Message body (required)
--context-code string Context code (e.g., course_123)
--force-new Force new conversation
--group Send as group message
-h, --help help for create
--media-comment-id string Media comment ID
--recipients string Recipient IDs (comma-separated, required)
--subject string Subject line
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 conversations - Manage Canvas conversations (inbox)