Unsubscribe recipients
Add email addresses to your team's unsubscribe list so no campaign emails them again.
POST https://cotlet.dev/api/v1/mailshake/recipients/unsubscribe
write Confirm
Adds a list of addresses to the unsubscribe list of your team. It applies to every campaign, and add_recipients skips these addresses from then on. This tool cannot remove an address from the list again. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| email_addresses string[] required | string[] | Addresses to unsubscribe. |
Request
curl -X POST https://cotlet.dev/api/v1/mailshake/recipients/unsubscribe \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email_addresses":["jane@example.com"]}'result = client.call("mailshake", "unsubscribe_recipients", {"email_addresses":["jane@example.com"]})const result = await cotlet.call('mailshake', 'unsubscribe_recipients', {"email_addresses":["jane@example.com"]});cotlet call mailshake unsubscribe_recipients --data '{"email_addresses":["jane@example.com"]}'Example response
{
"unsubscribed": [
"li@oldclient.example"
]
}