Add leads to a campaign
argorant_add_campaign_leadsThis spends credits. Add people to a campaign from a saved list (list_id), from people of a search (record_ids), from another campaign of the workspace (lead_ids with from_campaign_id) or from rows the user gives you. Use it to fill a campaign before a launch; to take people out use argorant_remove_campaign_leads, and to move them between campaigns use argorant_move_campaign_leads. Each new person from Argorant costs 1 credit, like a reveal. People already unlocked, people already in the campaign and the user's own rows are free, and argorant_account shows the credits left. Tell the user the cost and ask the user before adding, every time. Call it first without grades. When the people include addresses that are not plainly valid, the answer is needs_choice, with counts, a question and a plain explanation of catch-all, unknown and risky, and nothing is added yet. Put that question to the user in its own words, recommend valid only, then call again with grades=["valid"] or ["valid", "catch_all"]. Invalid addresses are never added, the same person joins once, and addresses still being checked join later if they match the choice. If credits run out, the first people are added and the rest are reported. More than 2,000 people, or a slow add, runs in the background with a job_id; follow it with argorant_add_campaign_leads_status about every 30 seconds. Calling again with the same list and choice returns the same job, so nobody is added or charged twice. "Add the rest" means the rest of the search into the SAME list (argorant_create_list with its list_id), then this again with that list_id. The answer's summary says where every person went; tell the user in its words. Nothing is sent until the campaign is launched. 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_add_campaign_leads"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | The user's own people, as [{email, first_name?, last_name?, company?, title?}], up to 5,000. A row whose address Argorant knows gets its empty name, title and company filled in (filled_from_argorant). Free. | |
| grades | No | What the user chose after needs_choice, ["valid"] (recommended) or ["valid", "catch_all"]. It is saved for the campaign. Leave it out on the first call. Unknown and risky addresses cannot be sent to yet. | |
| list_id | No | A saved list, from argorant_create_list or argorant_list_lists. Adding it again later adds only the people not in the campaign yet. | |
| lead_ids | No | People already in another campaign (ids from argorant_list_campaign_leads); needs from_campaign_id. | |
| record_ids | No | People of a search: the same ids argorant_create_list takes. 1 credit per new person, like a list. | |
| campaign_id | Yes | The campaign's id, from argorant_list_campaigns. | |
| restore_removed | No | Bring back people of this add who were taken out of the campaign earlier and never emailed. When it is left out, rows, record_ids and lead_ids bring them back and a saved list does not. | |
| from_campaign_id | No | The campaign the lead_ids are in. Same workspace only. | |
| include_catch_all | No | Older form of grades=["valid", "catch_all"]; prefer grades. | |
| keep_given_address | No | true adds the addresses exactly as given. By default a better address of a person can take the place of the one in the campaign (counted in swapped) and a second address of the same person is left out (alternate_skipped); tell the user both. | |
| exclude_private_emails | No | true leaves out free mail and home internet addresses, counted in skipped_private_email. Only when the user asks for business emails only. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |