Add Recipients
add_recipientsAdd people to an existing Canvas Inbox conversation so they receive its messages. Preview the recipients, then confirm to complete the addition after user approval.
Instructions
Add more people to an existing Inbox conversation so they receive its messages. Get user IDs from find_recipients. [NEEDS CONFIRMATION: call it once for a preview and a confirm_token, show the preview to the user, and only if they say yes call it again with the same arguments, confirm=true and that confirm_token. Apps that can ask the user directly show a confirmation instead.]
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"conversation_id": "<conversation_id>",
"recipients": "<recipients>"
},
"name": "add_recipients"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Set to true together with confirm_token to carry out a request you already previewed. | |
| recipients | Yes | User IDs to add, from find_recipients. | |
| confirm_token | No | The one-time token from the preview. Only use it after the user has said yes. | |
| conversation_id | Yes | Inbox conversation ID (numeric string). Get it from list_conversations. |