fbpx

Email Sequence API

You are here:
< All Topics
Table of Contents

How to use Saturn Funnel’s API for email sequences in trials or marketing?

Email Sequences

In addition to adding, and removing, a contact to an email sequence via built-in forms, CTAs, Popups, and landing pages you can add and remove contacts from sequences via our API.

Add Contact to Sequence

Along with the api_key, either the email, visitorId or contact _id is needed to identify the contact to add to a sequence.

JSON Endpoint:

post: //api.saturnfunnels.com/api/app/contact/sequence/add

{

api_key: string, //  required: found in dashboard

sequence_id: string, //  required: found in dashboard for each email sequence

reset: boolean, // optional true, to force a restarting of the sequence from email #1

// one of the following 2

contact_id: string, // unique contact identifier,

visitorId: string, // either contact_id or visitorId is required

}

Result

{

status: ‘ok’,

type: ‘sequence added

}

Remove Contact from a Sequence

You might want to remove a contact from a sequence if they enter another, such as reaching a milestone in a trial or onboarding. This can be done right in the sequence editor under the Settings tab, but you may want/need more control and this API endpoint allows programmatic removal from a sequence.

Along with the api_key, either the email, visitorId or contact_id is needed to identify the contact to remove.

JSON Endpoint:

post: //api.saturnfunnels.com/api/app/contact/sequence/remove

{

api_key: string, //  required: found in dashboard

sequence_id: string, //  required: found in dashboard for each sequence

// one of the following 2

contact_id: string, // unique contact identifier,

visitorId: string, // either contact_id or visitorId is required

}

Results

{

status: ‘ok’, 

type: ‘sequence removed’

}