Configuring iContact API 2.0

To start using iContact as your email Auto Responder you will need to complete a few easy steps first. These steps are described here for your reference.

 

1.    Where to obtain your iContact Account? go to www.icontact.com and sign up for a Free Trial first, no credit card will be required.

 

2.    Create your Account: enter the information required by iContact and get your Free Trial.  

 

3.    Create iContact API application ID: once your account has been set up, now you can open a new tab and go to https://app.icontact.com/icp/core/registerapp to create your iContact API application ID:

Icontact_Get_App_Id.png

 

Create an Application Name and Description and click on “Get App ID”.

 

4.    Get your Application ID: in the next screen you will see your Application Name & Description, right below that you will see the option to show information for API 2.0 or 1.0, you must select API 2.0.

 

5.    Get API App Id: once you have selected the option to show information for API 2.0, the information for your application will appear at the bottom of the page, providing you with your API – AppId (you can save this in a separate document since you will need it in future steps), for example:

 

API-AppId: 6kMKirCWGdFleKtcLKNUsxh8B5cpzDh4

 

The screen will look like this:

Icontact_Your_App_Id.png 

 

6.    Enable the App Id for your account: the next step will be to click on the link at the bottom of the page that says “enable this AppId for your account”.  Now a new screen will come up showing your Application ID and requesting you to create a password for your application. Make sure you save this information as you will need it in future steps. 

 Icontact_Access_Your_Account.png

  

A confirmation will be shown to you that your application “X” (your application name) can now access your account, using the password you provided.

 

7.    Create Two List IDs for your Campaigns: You may have a list of prospects and a list of customers for each campaign. For some of them the list of prospects may be the same if the campaigns are very similar; this means that you can use the same list for multiple campaigns; however, the list of customers will differ from one to another. You will be able to create as many lists as you need depending on your needs for the Campaign(s) you are working on. 

 

To start creating your first list click on "Contacts” >”My Lists”> “Create a List”. You can name your first list Prospects and add a description to it. For instance, Prospects for Campaign XY, and click “Save” at the bottom of the page. Now click on “Create a New List” to create your second list, you can name this list Customers and add a description to it. For instance, Customers of Campaign XY and click “Save”. 
When creating each list, you will be required to also include a public list label.

Icontact_Create_List.png

 

Now, your two new lists will appear under your Lists.

 

With iContact you can set up as many lists as you need to, and have easy access to manage each of them as necessary. For this example we are only setting up two lists for one specific campaign.

Icontact_My_List.png

 

 

8.    Create Sign-Up Forms to generate Lists IDs: now your two lists are ready to use and the following step is to generate the List IDs for each.  

 

Go to  Contacts >Sign-Up Forms, click on “Create HTML Form”. For this example, we will create the Sign-Up Form for the Prospects list first.

 

Fill in a name for the Sign-Up Form, you can name it Prospects as well if you wish, and then click the checkbox of the List associated with it, which in this case will be Prospects, and save. No other fields are required.

Icontact_Sign-Up_Form.png

 

Once you click “Save”, you will be taken to the Create or Edit Sign-up Forms page. Click "View HTML" for the sign-up form you have created. Under the Manual Sign-Up Form heading, scroll through it and look for the “listid” which is usually around the middle of the code.  When you find the “listid” value, please save this value as it will be needed in the campaign configuration of iContact within the Lime Light CRM as seen in step 11.

 

For example: List ID 9978.

Icontact_List_Id_value.png

 

Repeat the same process to generate a List ID for your Customers List.

 

Go to  Contacts >Sign-Up Forms, click on “Create HTML Form”. Fill in the Sign-Up Form name, you can name it Customers if you wish, and then click the checkbox of the List associated with it, in this case Customers, and save. 

Once in the new screen, go to Manual Sign-Up Form and scroll through it to look for the “listid” (around the middle of the code), when you find the “listid”, go ahead and save the value.

 

 

9.    Obtain the Client Folder Name: From the home page, click on the drop down menu located at the upper right corner of the page, and select “Client Folders”.You will have now two lists in your screen: My Client Folders and My Users. Under My Client Folders you will be able to see your main Client Folder name as shown below: 

iContact_Client_Folder.png 

  If you have multiple Client Folders, they will be listed here. 

 

NOTE: Client Folders tab is not available on all accounts; if your iContact account does not have one, please just skip this step and go to the next one. 

 

 

10.  Add the Email Provider to your Lime Light CRM account: at this point you must already have your iContact account completely set up. Go to your Lime Light CRM account and go to Auto Responders>Email Providers. Select iContact 2.0 as your email provider and click “Add Email Provider”. 

iContact_2.0-LL.png

  


A pop up will come up asking you for the iContact 2.0 parameters, please be aware that this is case sensitive:

  • Username – username that you created with iContact  
  • API Password – password that you created and save in step 6
  • API Id – provided by the email provider in step 5
  • Client Folder Name – obtained in Step 9, it is case sensitive and must be submitted exactly as it appears in your  iContact list of Client Folders. If your account does not have a Client Folder, just leave this field blank.
  • Alias – create an alias for internal purposes only. This alias will help you organize among multiple providers in the future, since you may have multiple iContact accounts within our system.

Then save it.

icontact2.0parameters.png

 

When creating a new campaign or editing an existing campaign you can assign a new email provider and list ID’s if you wish.

 

11.   Add the list IDs to your Campaign: When creating or editing your Campaign XY, you will see at the very bottom of the page the option to enable an Auto Responder for this Campaign. Once you select an Auto Responder, iContact 2.0 in this case, two more fields will appear: Prospect List ID and Customer List ID. You will enter the “listid” value you got from the Manual Sign-Up Form, for our example the Alias we used  is “iContact2.0-test” and the List ID for each list are submitted as in the following illustration, and click “Save”: 

  

Assign_iContact_to_a_Campaign.png

Please be aware that you need to go through the iContact set up only once. After you have your account set up and get all the API information needed from them, you can easily create, access and manage your Lists and assign them to your Campaigns as needed.

 

 

 

Adding Custom Fields with iContact 2.0

Custom Field 1 - Custom Field 5: Custom Fields are optional and they are described below. 

Custom Fields:

 

iContact contains multiple Custom Fields that allow you to customize the data that you will be processing through their auto responder system. These Custom Fields will append certain information to your records based on the customer/prospect details. Please be aware that these fields are optional.

 

To ease the process of using the Custom Fields, at Lime Light CRM we have created various Tokens that you can use to dynamically insert certain values into these Custom Fields depending on what values you want to send over to iContact.

 

These are the tokens you can use and a brief description of the values that each one will insert in your Custom Fields:

 

{affiliateurl}
Inserts the appending affiliate tokens with a full affiliate and sub-affiliate query string from the order. It will obtain this value from the AFID, SID, AFFID, C1, C2, C3, AID and OPT fields, whichever is populated; if none of them have data, it will not be included on the post.

{temporderid}

Inserts the appending temporderid from Lime Light CRM. This will only be used in cases where you have a two page campaign, and should only be used on your prospect lists within iContact. The temporderid is used to relate the prospect or abandon customer within Lime Light CRM. Example, if you wanted to send out an email to a prospect that has left your site and direct them back to your order page, without require them to fill out the information they have already provided you, then you can append the temporderid to your order page URL within your Auto Responder message.

 

{orderid}

 Inserts the appending orderid from the Lime Light CRM.

 

{prospectid}

 Inserts the appending prospectid from the Lime Light CRM.

 

 

Other Available Tokens:

 

{affiliate}

{subaffiliate}

{productname}

 

How to setup Custom Fields within iContact.

 

From your iContact home page, click on the drop down menu located at the upper right corner of the page, and select Custom Fields.

 

 

To add {affiliateurl} inside iContact’s custom fields: fill in the custom field form as shown below. Also make sure to uncheck the "Show field to subscribers" as you do not want to display these custom fields to your customer. Please keep in mind iContact is case sensitive so make sure to enter in all lower case letters as shown below.

iContact_Client_Create_Custom_Fields.png

 

To add {temporderid} inside iContact’s custom fields: fill in the custom field form as shown below. Also make sure to uncheck the "Show field to subscribers" as you do not want to display these custom fields to your customer.

iContact_Client_Create_Custom_Fields_II.png

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.