acquisition. campaign. create
Start a campaign from a pain point or company list. Find decision-makers and draft up to five emails for approval.
Charged by the tools it calls. demand.radar 90 (when it starts from a pain), contact.resolve 25 per person found.
Example prompt
Send this to your AI app when Heelo is connected:
Start a campaign to the CTOs of the companies from my last ICP search, with three short e-mails for days 0, 3 and 7. Show me the people and the e-mails before anything is sent.
Input fields
| Field | Type | Description |
|---|---|---|
nameRequired | string | A name for the campaign. It also names the mail sequence. |
pain | string | Source 1: the problem the customers have, in plain words (the ICP's pain). Heelo searches public posts for people who say they have it, and looks up contacts at their companies. Give pain or companies, not both. |
companies | array of object | Source 2: the companies to reach (1 to 200), for example from icp.search. Give pain or companies, not both. |
radar_platforms | array of string | With pain only: the platforms to search, from reddit, bluesky, twitter, web, github and hackernews (default reddit, bluesky, web, github, hackernews). |
radar_window_days | integer | With pain only: how many days back to search. |
target_roles | array of string | The roles to reach at each company, best first, for example ['head of finance', 'CFO']. |
from_domainRequired | string | The domain the mail is sent from. It must be a sender that can send: acquisition.campaign.create says which one when it is not. |
from_name | string | The display name in the From header. |
reply_to | string | The mailbox where replies are read, so that a reply stops the sequence for that person. Leave it out to use the deployment's reply address. |
stepsRequired | array of object | The messages, 1 to 5, for example days 0, 3 and 7. Templates may use {{full_name}}, {{company_domain}} and {{tracking_url}} (a tracked link: put it in at least one step so that a click is attributed to the person). The footer (Advertisement, the postal address and an unsubscribe link) is added to every message. |
daily_cap | integer | The most messages a day from this domain. |
target_contacts | integer | Stop looking up contacts when this many are found (1 to 200). |
contacts_per_company | integer | The most contacts at one company (1 to 3). |
jurisdiction | string | The country of the people to reach, as a two-letter code: US or CA. Other countries are refused (policy, jurisdiction_blocked) before any lookup. |
physical_address | string | Required by law (CAN-SPAM): the sender's postal address, added to every message. Ask the user for it and never make one up. A call without it is refused (policy, missing_statutory_element). |
ad_disclosure | boolean | Required by law (CAN-SPAM): must be true. It confirms that each message is an advertisement; the footer says so. Ask the user and never set it on your own. A call without it, or with false, is refused (policy, missing_statutory_element). |
Code
The call with the input fields that the tool needs. Replace each word in capitals, such as NAME. Set HEELO_API_KEY to your API key.
import os
import requests
response = requests.post(
"https://toolsprimitives.uk/v1/tools/acquisition.campaign.create/invoke",
headers={"Authorization": f"Bearer {os.environ['HEELO_API_KEY']}"},
json={"input": {
"name": "NAME",
"from_domain": "example.com",
"steps": [{"day": 0, "subject_tpl": "SUBJECT_TPL", "body_tpl": "BODY_TPL"}],
"companies": [{"domain": "example.com"}],
"physical_address": "PHYSICAL_ADDRESS",
"ad_disclosure": True,
}},
timeout=120,
)
response.raise_for_status()
print(response.json())// Node.js 18 or newer, in an ES module.
const response = await fetch("https://toolsprimitives.uk/v1/tools/acquisition.campaign.create/invoke", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.HEELO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
input: {
"name": "NAME",
"from_domain": "example.com",
"steps": [
{
"day": 0,
"subject_tpl": "SUBJECT_TPL",
"body_tpl": "BODY_TPL"
}
],
"companies": [
{
"domain": "example.com"
}
],
"physical_address": "PHYSICAL_ADDRESS",
"ad_disclosure": true
},
}),
signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());