Estimate Campaign Recipients
estimate_campaign_recipientsCount how many people a campaign would reach if it were sent now to the given lists, segments and tags, after leaving out the excluded lists, segments and tags, removing duplicates and skipping suppressed contacts (optionally also frequency-capped ones). Give at least one list, segment or tag. Sends nothing and changes nothing.
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": "estimate_campaign_recipients"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag_ids | No | Tag IDs to send to | |
| list_ids | No | List IDs to send to (as shown by list_lists) | |
| segment_ids | No | Segment IDs to send to | |
| frequency_cap | No | Also skip contacts emailed recently (the account's frequency cap window) | |
| exclude_tag_ids | No | Tag IDs to leave out | |
| exclude_list_ids | No | List IDs to leave out | |
| exclude_segment_ids | No | Segment IDs to leave out |