outbound. mail
Manage outreach through the legacy action parameter. Use the dedicated outbound.mail tools for new integrations.
0 credits. Free for the call. Each e-mail it sends is charged 5.
Example prompt
Send this to your AI app when Heelo is connected:
List the sender addresses of my outreach e-mail.
Input fields
| Field | Type | Description |
|---|---|---|
actionRequired | string | domain.check, contact.add, contact.list, consent.record, sequence.create, sequence.enroll, sequence.status, sequence.stop, sequence.resume, suppress.add, suppress.check, reputation.status, sender.add, sender.verify, sender.list, sender.remove |
params | object | The action's fields, as the input schema of its own tool, outbound.mail.<action>, gives them. |
Code
The call with the input fields that the tool needs. Replace each word in capitals, such as ACTION. Set HEELO_API_KEY to your API key.
import os
import requests
response = requests.post(
"https://toolsprimitives.uk/v1/tools/outbound.mail/invoke",
headers={"Authorization": f"Bearer {os.environ['HEELO_API_KEY']}"},
json={"input": {
"action": "ACTION",
}},
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/outbound.mail/invoke", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.HEELO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
input: {
"action": "ACTION"
},
}),
signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());