API Reference

References

References to key terms used in this docs

Campaign

A campaign refers to an outreach sequence you want to run to a list of leads with certain conditions.

Lead

A lead in the API is the same as the lead in your app. They are the recipient of your email / the person you’re trying to contact. Aka the people you provide value to with the awesome products/services you have to sell to them

Update

Whenever you need to update a campaign or a lead,

Unsubscribe

When someone no longer wants to hear from you, they unsubscribe, aka the no more touchy zone.

Lead Status

STARTED:The lead is scheduled to start and is yet to receive the 1st email in the sequence.
COMPLETED:The lead has received all the emails in the campaign.
BLOCKED:A lead is blocked when the email sent is bounced or if added in the global block list
INPROGRESS: The lead has last received at least one email in the sequence.