send_conversation
Send messages to students through Canvas conversations, supporting individual or group messaging with attachments and bulk delivery options.
Instructions
Send messages to students via Canvas conversations.
Args:
course_identifier: Canvas course ID or code
recipient_ids: List of Canvas user IDs to send to
subject: Message subject line (max 255 characters)
body: Message content (required)
group_conversation: If True, creates group conversation (required for custom subjects)
bulk_message: If True, sends individual messages with same subject to each recipient
context_code: Course context (e.g., "course_60366")
mode: "sync" or "async" for bulk messages (>100 recipients should use async)
force_new: Force creation of new conversation even if one exists
attachment_ids: Optional list of attachment IDs
Returns:
Dict with conversation details or batch operation status
Input Schema
Name | Required | Description | Default |
---|---|---|---|
attachment_ids | No | ||
body | Yes | ||
bulk_message | No | ||
context_code | No | ||
course_identifier | Yes | ||
force_new | No | ||
group_conversation | No | ||
mode | No | sync | |
recipient_ids | Yes | ||
subject | Yes |
Input Schema (JSON Schema)
{
"properties": {
"attachment_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Attachment Ids"
},
"body": {
"title": "Body",
"type": "string"
},
"bulk_message": {
"default": false,
"title": "Bulk Message",
"type": "boolean"
},
"context_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Context Code"
},
"course_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"title": "Course Identifier"
},
"force_new": {
"default": false,
"title": "Force New",
"type": "boolean"
},
"group_conversation": {
"default": false,
"title": "Group Conversation",
"type": "boolean"
},
"mode": {
"default": "sync",
"title": "Mode",
"type": "string"
},
"recipient_ids": {
"items": {
"type": "string"
},
"title": "Recipient Ids",
"type": "array"
},
"subject": {
"title": "Subject",
"type": "string"
}
},
"required": [
"course_identifier",
"recipient_ids",
"subject",
"body"
],
"type": "object"
}