Opt-out list
suppress_contactAdd an email address or whole domain to a key's opt-out list, or remove it, so later contact checks return blocked at no charge. Use it when someone unsubscribes or asks not to be contacted.
Instructions
Add an email address or a whole domain to this key's opt-out list, or remove it. Use it when someone unsubscribes, replies asking not to be contacted, or must never be emailed. Every later contact_check on a listed address answers blocked, free of charge, so the list works across every tool that uses the same key. Needs PRECLEARED_API_KEY: the list belongs to a key. Nothing is sent to the recipient.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "suppress_contact"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | The address to list. Give this or domain. | ||
| domain | No | A whole domain to list, for example acme.co.uk. Give this or email. | |
| reason | No | Why, in a few words, for example 'replied asking not to be contacted'. Kept with the entry. | |
| remove | No | True to take the address or domain off the list instead. Default false. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entry | No | The entry: id, type, masked_email, domain, reason, source, created_at. | |
| charged | No | Always false: listing is free. | |
| created | No | True when a new entry was added; false when it was already listed. | |
| removed | No | True when an entry was removed. |