Revoke Email Permission
revoke_email_consentTake back email permission for existing customers so no campaign can email them. Pass lead_id and email for one customer, or emails for up to 200, with evidence_ref saying why. Needs an admin of the business.
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": {
"business_id": "<business_id>",
"evidence_ref": "<evidence_ref>"
},
"name": "revoke_email_consent"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | That customer's email address. | ||
| emails | No | Email addresses of existing customers, up to 200, as an alternative to lead_id. | |
| lead_id | No | One existing customer (lead id), paired with email. | |
| business_id | Yes | The business that sends the email. | |
| evidence_ref | Yes | Where the permission came from or why it is withdrawn, e.g. 'web form opt-in' or 'customer asked to stop'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| code | No | ||
| error | No | Present when success is false | |
| action | No | ||
| status | No | ||
| success | Yes | Whether the tool completed successfully | |
| senderId | No | ||
| fingerprint | No |