Remove many people from a campaign
argorant_remove_campaign_leadsTake many people out of a campaign at once, chosen by status, reply, bounce, address domain, tag, lead_ids, addresses, a CSV file of ids or addresses (up to 100,000) or a saved list. Use it for bulk clean ups. For one address use argorant_remove_campaign_lead, and to bring people back use argorant_restore_campaign_leads. Always call it first with preview=true and tell the user how many would be taken out and how many stay because they already got an email. People who already got an email stay unless the user clearly asks to stop them too (include_contacted=true); then the ones still waiting for a follow-up get no more emails, and replies and bounces are never touched. Nobody is deleted, and emails already sent stay in the numbers. Doing it needs confirmed=true after the user's clear yes. For many people, tag them with argorant_set_lead_custom_fields and remove by tag, or pass a file, instead of long id lists. More than 2,000 people are taken out in the background, with a job_id for argorant_add_campaign_leads_status. More in the docs at https://docs.argorant.com/docs/agents/tools#campaigns
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": {
"campaign_id": "<campaign_id>"
},
"name": "argorant_remove_campaign_leads"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Everyone who carries this tag (set with argorant_set_lead_custom_fields). | |
| file | No | CSV text of lead ids or email addresses (a header such as id or email is optional), up to 100,000. | |
| emails | No | The people's email addresses. | |
| status | No | pending, queued, active, sent, replied, bounced, unsubscribed, failed or completed. | |
| bounced | No | true for only the bounced addresses, false for only the others. | |
| domains | No | Domains of the people's addresses. | |
| list_id | No | Everyone of this saved list. | |
| preview | No | Set it to true to only count, without changing anything. | |
| replied | No | true for only the people who replied, false for only the ones who did not. | |
| lead_ids | No | Ids from argorant_list_campaign_leads. | |
| confirmed | No | true only after the user's clear yes to taking these people out | |
| campaign_id | Yes | The campaign's id, from argorant_list_campaigns. | |
| include_contacted | No | Also stop people who already got an email. Only when the user asks for it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |