outbound. mail. sequence_ enroll
Enroll a contact in a sequence so the sending worker can deliver emails on schedule.
5 credits per e-mail. Free for the call. Each e-mail sent is charged 5 when the mail provider accepts it. A later bounce is not refunded.
Example prompt
Send this to your AI app when Heelo is connected:
Enroll the five contacts I added today in my free-trial sequence.
Input fields
| Field | Type | Description |
|---|---|---|
sequence_idRequired | string | The sequence's id, from outbound.mail.sequence_create. |
contact_idsRequired | array of string | Contact ids, from outbound.mail.contact_add or contact.resolve. A contact is enrolled only when no verifier called its address undeliverable, it has consent (outbound.mail.consent_record) and the pre-send checks pass; the answer gives each skipped contact with its reason (and, when the check names one, its detail_code and message, such as sender_domain_not_ready). |
Code
The call with the input fields that the tool needs. Replace each word in capitals, such as SEQUENCE_ID. Set HEELO_API_KEY to your API key.
import os
import requests
response = requests.post(
"https://toolsprimitives.uk/v1/tools/outbound.mail.sequence_enroll/invoke",
headers={"Authorization": f"Bearer {os.environ['HEELO_API_KEY']}"},
json={"input": {
"sequence_id": "SEQUENCE_ID",
"contact_ids": ["CONTACT_ID"],
}},
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.sequence_enroll/invoke", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.HEELO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
input: {
"sequence_id": "SEQUENCE_ID",
"contact_ids": [
"CONTACT_ID"
]
},
}),
signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());