Active with remarks |
---|
This application needs additional settings. Please follow the documentation below to create your connection. |
The Elastic Email modules allow you to create, update, retrieve, list, and delete the contacts, lists, campaigns, and emails in your Elastic Email account.
Prerequisites
-
An Elastic Email account
In order to use Elastic Email with Boost.space Integrator, it is necessary to have an Elastic Email account. If you do not have one, you can create an Elastic Email account at elasticemail.com/account#/create-account.
![]() |
Note |
---|---|
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory! |
To connect your Elastic Email account to Boost.space Integrator you need to obtain the API Key from your Elastic Email account and insert it in the Create a connection dialog in the Boost.space Integrator module.
-
Log in to your Elastic Email account.
-
Click Your User Name > Settings > API > Accept Consent > Create API Key. Enter a name for the key, select the permissions, and click Create. Copy the API key to your clipboard.
-
Go to Boost.space Integrator and open the Elastic Email module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the API key copied in step 2.
-
Select whether you want to establish the connection for private branding and enter the custom domain. For example,
<yourdomain.cz(uk, etc.)>
. You can find at My Account > Settings > Domains. -
Click Continue.
The connection has been established.
Triggers when a new contact is added to the list.
|
|
|
Select the contact list name whose contacts you want to watch. |
|
Set the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Adds a new contact and optionally to one of your lists.
|
|
|
Enter the email address of the contact. |
|
Enter the Public Account ID for the contact. This is a public key that provides limited access to the contact. You can find the public key at My Account > Security. |
|
Enter the first name of the contact. |
|
Enter the last name of the contact. |
|
Add the contact list to which you want to add the contact. You can add multiple contacts. |
|
Select whether you want to allow the consent tracking for the contact. |
|
Select whether you want to send the activation email to the contact once you create the contact. |
|
Select the activation template to send to the contact as an activation email. |
|
Add the email address to which contact’s subscription notification emails will be sent. |
|
Enter the URL address to which contact will be redirected after activation. |
|
Enter the URL address to which contact is redirected if already subscribed. |
|
Enter the date on which the contact is provided consent. |
|
Enter the IP address of consent to send this contact from your email. |
|
Enter the URL address to navigate to after account creation. |
|
Select the option in which the contact details are uploaded:
|
|
Enter the URL address from which the request for creating the contact was sent. |
Loads detailed contact information.
|
|
|
Select the email address of the contact whose details you want to retrieve. |
Updates a selected contact.
|
|
|
Select the email address of the contact whose details you want to update. |
|
Enter the first name of the contact. |
|
Enter the last name of the contact. |
|
When selected, resets the fields which are omitted in this request. |
|
Add the custom fields for the contact:
Enter the field name. For example, the company name.
Select the field type:
Enter the field value. |
Permanently deletes the contacts provided. You can provide either a qualified rule or a list of emails.
|
|
|
Select the option through which you want to delete the contacts:
|
|
Add the email addresses of the contact whom you want to delete. |
|
Select the option to filter the contacts whom you want to delete based on the specified query. |
Searches the contacts or lists them all.
|
|
|
Select the option to sort the contacts you want to list:
|
|
Select the option to filter the contacts whom you want to list based on the specified query. |
|
Set the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Manually adds or updates a contact to unsubscribed status.
|
|
|
Select the email address of the contact whom you want to unsubscribe. |
Creates a new list based on the filtering rule or list of IDs.
|
|
|
Select whether you want to create an empty list. |
|
Enter a name for the list. |
|
Add the email addresses of the contacts whom you want to add to the list. |
|
Select to add all the contacts from your account to the list. |
|
Select to allow to unsubscribe the contacts from the list. |
|
Select the option to filter the contacts whom you want to add to the list based on the specified query. |
Gets detailed information about a specific list.
|
|
|
Select the list whose details you want to retrieve. |
Updates an existing list.
|
|
|
Select the list whose details you want to update. |
|
Enter a new name for the list. |
|
Select whether you want to allow the contacts in the list to unsubscribe. |
|
Select whether you want to track the history of the list. |
Deletes a list and removes all the contacts from it (does not delete contacts.
|
|
|
Select the list you want to delete. |
Searches the lists or lists them all.
|
|
|
Enter the date to list the lists that are created or updated on or after the specified date. |
|
Enter the date to list the lists that are created or updated on or before the specified date. |
|
Set the maximum number of lists Boost.space Integrator should return during one scenario execution cycle. |
Triggers when a new campaign is sent.
|
|
|
Set the maximum number of campaigns Boost.space Integrator should return during one scenario execution cycle. |
Submits the emails.
|
|
|
Add the recipient’s email addresses to whom you want to send the email. |
|
Add the contact lists to which you want to send the email. |
|
Add segments to which you want to send the email. Insert |
|
Enter the email address from which you want to send the email. |
|
Enter the name that appears in the email. |
|
Enter the subject line of the email. |
|
Select the email Template ID. The templates must be created in your account. |
|
Add the attachments to the email. |
|
Enter the sender’s email address to which you want to send the email. |
|
Enter the sender’s name. |
|
Enter the email address to which the recipient can reply to your email. |
|
Enter the name to which the recipient can reply to the email. |
|
Select whether you want to track the clicks fro the email. |
|
Select whether you want to track when the email is opened. |
|
Select whether this is a transactional email. |
|
Add the email address that appears in the To field of the email. This field is ignored if the To parameter is also provided. Visible to all other recipients of the message as TO MIME header. |
|
Enter the email address that appears in MIME header. |
|
Enter name of the sender that appears in MIME header. |
|
Add the recipient’s email address that you want to mention in the BCC field. |
|
Add the recipient’s email address that you want to mention in the CC field. |
|
Enter the AMP email message text. |
|
Enter the email message text in HTML format. |
|
Enter the email body text. |
|
Enter the Channel ID that can be used for reporting. The ID can be of maximum 191 characters. |
|
Enter the text value of charset encoding. For example, iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 |
|
Enter the charset for body AMP MIME part. |
|
Enter the charset for body HTML MIME part. |
|
Enter the charset for body text MIME part. |
|
Enter the name or ID of the previously uploaded file. It must be a CSV list of recipients. |
|
Select the encoding type for the email. |
|
Enter the file name of the attachments which is a CSV list of recipients. |
|
Enter the name of your custom IP Pool to be used in the email sending process. |
|
Enter an optional header returned in notifications. |
|
Enter the number of the minutes after which the email must be sent. You can send up to 1 year (524160 minutes). |
|
Enter the utm campaign marketing parameter appended to each link in the campaign. |
|
Enter the utm content marketing parameter appended to each link in the campaign. |
|
Enter the utm medium marketing parameter appended to each link in the campaign. |
|
Enter the utm source marketing parameter appended to each link in the campaign. |
Performs an arbitrary authorized API call.
|
||||
|
Enter a path relative to
|
|||
|
Select the HTTP method you want to use:
to retrieve information for an entry.
to create a new entry.
to update/replace an existing entry.
to make a partial entry update.
to delete an entry. |
|||
|
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|||
|
Enter the request query string. |
|||
|
Enter the body content for your API call. |
Do you need help with something specific regarding Elastic Email?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch