outbound. mail. sequence_ stop
Stop future emails in a sequence for a specific contact.
0 credits. Free: a stop is free.
Example prompt
Send this to your AI app when Heelo is connected:
Stop my free-trial sequence for [email protected].
Input fields
| Field | Type | Description |
|---|---|---|
enrollment_idRequired | string | The enrollment's id: enrollments[].id in outbound.mail.sequence_status. |
Code
The call with the input fields that the tool needs. Replace each word in capitals, such as ENROLLMENT_ID. Set HEELO_API_KEY to your API key.
import os
import requests
response = requests.post(
"https://toolsprimitives.uk/v1/tools/outbound.mail.sequence_stop/invoke",
headers={"Authorization": f"Bearer {os.environ['HEELO_API_KEY']}"},
json={"input": {
"enrollment_id": "ENROLLMENT_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_stop/invoke", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.HEELO_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
input: {
"enrollment_id": "ENROLLMENT_ID"
},
}),
signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());