Skip to content

Docs / All tools / Loop II: Acquisition

outbound.mail.sequence_create

Create an outreach sequence with 1 to 20 emails. Sending starts separately.

0 credits. Free: setup.

Example prompt

Send this to your AI app when Heelo is connected:

Create an e-mail sequence from [email protected] with three short e-mails for days 0, 3 and 7. Our postal address is 123 Main St, Springfield, IL 62701.

Input fields

FieldTypeDescription
nameRequiredstringA name for the sequence.
from_domainRequiredstringThe sending domain, for example mail.example.com. Check it first with outbound.mail.domain_check: enrollment and each send need it ready to send.
from_emailRequiredstringThe From address: a verified sender of this account (outbound.mail.sender_list). Its domain must be from_domain.
from_namestringThe display name in the From header.
reply_tostringLeave it out: replies go to Heelo's reply address, which stops the sequence for that contact and forwards the reply to the sender's forward_to. Any other address is refused.
stream"cold" | "transactional"The sending stream. The daily limits count each domain and stream apart.
stepsRequiredarray of objectThe messages to send, 1 to 20 steps.
physical_addressstringRequired by law (CAN-SPAM): the sender's postal address, added to the footer of every message. Ask the user for it and never make one up. A call without it is refused (policy, missing_statutory_element).
ad_disclosurebooleanRequired 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).
daily_capintegerThe most messages in one UTC day from this domain and stream, counting all your sequences; the warm-up limit can be lower. A step over the limit waits until the next day.
warmup_startintegerWarm-up: the daily limit on the first day this domain and stream send.
warmup_growthnumberWarm-up: how much the daily limit grows each day (0.2 = 20%), up to daily_cap.
stop_other_sequences_on_replybooleanA reply always stops this sequence for that contact. Set true to also stop every other sequence at that contact.

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/outbound.mail.sequence_create/invoke",
    headers={"Authorization": f"Bearer {os.environ['HEELO_API_KEY']}"},
    json={"input": {
        "name": "NAME",
        "from_domain": "example.com",
        "from_email": "[email protected]",
        "steps": [{"day": 0, "subject_tpl": "SUBJECT_TPL", "body_tpl": "BODY_TPL"}],
        "physical_address": "PHYSICAL_ADDRESS",
        "ad_disclosure": True,
    }},
    timeout=120,
)
response.raise_for_status()
print(response.json())