createUnsubscribe
Add email to unsubscribe list - Create a new unsubscribe record. Writes live data.
Instructions
Add email to unsubscribe list - Create a new unsubscribe record. Writes live data.
Use when: programmatically adding an email address to the Unsubscribe List.
Required: email.
email is the only meaningful input. Unsubscribe List addresses are excluded from newsletters and automated email campaigns. Transactional template emails (welcome, verification, notification) still send. No per-list opt-out.
See also: updateUnsubscribe (modify existing), deleteUnsubscribe (remove existing).
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": {
"email": "<email>"
},
"name": "createUnsubscribe"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | Email address to add to the Unsubscribe List. | ||
| definitive | No | Always 0. No effect on sending. |