Get Email Campaign
get_email_campaignRead a business's email campaigns: its sending addresses and their setup readiness, recent campaigns with status, revision fingerprint and outcome counts, and the customers who can be emailed (recorded consent, not on the do-not-email list). Pass campaign_id for one campaign, or sender_id for the DNS records that sending address's domain needs. Read-only; any member of the business can read.
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>"
},
"name": "get_email_campaign"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sender_id | No | Optional: that sender's domain setup records instead of the campaign view. | |
| business_id | Yes | ||
| campaign_id | No | Optional: one campaign. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| error | No | Present when success is false | |
| records | No | ||
| senders | No | ||
| success | Yes | Whether the tool completed successfully | |
| audience | No | ||
| campaigns | No |