Create Group
create_groupCreate a new group of recipients.
Recipient groups are used to specify multiple recipients for an email or email template in a reusable way. Group members can be added and removed after the group is created using the 'add_group_members' and 'remove_group_members' tools. After successful creation, the group can be used for enqueuing emails or creating email templates.
Example tool call
This call uses example arguments supplied in the tool’s input schema.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"GroupName": "VIP",
"Recipients": [
{
"Name": "Ada Lovelace",
"Address": "ada@example.com"
},
{
"Address": "bob@example.com"
}
]
},
"name": "create_group"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| GroupName | Yes | Name for the new group. | |
| Recipients | Yes | Recipients to add to the group. May be empty. Any pre-existing recipient names are updated with the provided names. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Result | Yes | Result of the operation. |