Constant Contact¶
The Constant Contact modules allow you to monitor, create, update, send, retrieve, list, and delete the contacts, contact lists, contact tracking reports, email campaigns, email scheduling, and email tracking report in your Constant Contact account.
Getting Started with Constant Contact¶
Prerequisites
- A Constant Contact account - create an account at constantcontact.com/de/account-home.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Constant Contact to Ibexa Connect¶
-
Go to Ibexa Connectt and open the Constant Contact module's Create a connection dialog.
-
In the Connection name field, enter a name for the connection and click Continue.
-
Confirm the access by signing into your Constant Contact account.
The connection has been established.
Contact¶
Watch Contacts¶
Triggers by contact create or update events. Optionally filters by contact status.
Required Permissions: contact_data
| Event | Select or map the events you want to watch for the contact. For example, create, update, or delete. |
| Contact Lists | Select or map the contact lists whose contacts you want to watch. |
| Limit | Set the maximum number of contacts Ibexa Connect should return during one scenario account. |
List Contacts¶
Retrieves a list of contacts and filters by criteria.
Required Permissions: contact_data
| Status | Select or map the status of the contacts you want to list. For example, active. |
| Enter (map) the email address of the contact you want to list. | |
| Contact Lists | Select or map the contact lists whose contacts you want to list. |
| Updated After | Enter (map) the date to list the contacts that were updated on or after the specified date. See the list of supported date and time formats. |
| Limit | Set the maximum number of contacts Ibexa Connect should return during one scenario account. |
Create a Contact¶
Creates a new contact.
Required Permissions: contact_data
Create Source |
Select or map the source from where you want to create the contact. |
||||||||||||
Enter (map) the contact's email address. |
|||||||||||||
Permission to Send |
Select or map the permissions for the contact. For example, |
||||||||||||
First Name |
Enter (map) the contact's first name. |
||||||||||||
Last Name |
Enter (map) the contact's last name. |
||||||||||||
Job Title |
Enter (map) the contact's job title. |
||||||||||||
Company Name |
Enter (map) the company name with which the contact is associated. |
||||||||||||
Birthday Month |
Enter (map) the contact's birthday month number. This field is required if you use the birthday day field. Enter (map) a value between 1 and 12. |
||||||||||||
Birthday Day |
Enter (map) the contact's birthday day number. This field is required if you use the birthday month field. Enter (map) a value between 1 and 31. |
||||||||||||
Anniversary |
Enter (map) the date on which contact converted to the customer of the organization of Constant Contact. See the list of supported date and time formats. |
||||||||||||
Phone Number |
Add the phone numbers of the contact: Phone Number Enter (map) the contact's phone number. Kind Select or map the phone number type. For example, |
||||||||||||
Street Addresses |
Add the contact's address:
|
||||||||||||
Custom Field |
Add the custom fields and their values for the contact. |
||||||||||||
Contact List IDs |
Select or map the Contact List ID to which you want to add the contact. |
Import Contacts¶
Imports contacts by an array of contacts. Existing contact with the same email will be replaced.
Required Permissions: contact_data
Contacts |
Add the contact details you want to import.
|
||||||||||||||||||||||||||||||||
Contact List ID |
Add the Contact List IDs whose contacts you want to import. |
Import Contact by CSV¶
Imports contacts by a CSV file. Only the first 4 MB of the file will be imported if the file exceeds 4 MB.
Required Permissions: contact_data
| Contact List IDs | Add the Contact List IDs to which you want to add the contacts. |
| File Name | Enter (map) the file name containing the contacts including the extension. For example, sample.csv. |
| Data | Enter (map) the data of the file. The CSV file you are importing. The column headings that you can use in the file are first_name, last_name, email, phone, job_title, anniversary, birthday_day, birthday_month, company_name, street, street2, city, state, zip, and country. The only required column heading is email |
Update a Contact¶
Updates a contact by its ID.
Required Permissions: contact_data
Contacts |
Add the contact details you want to import.
|
||||||||||||||||||||||||||||||||
Contact List ID |
Add the Contact List IDs whose contacts you want to import. |
Delete a Contact¶
Removes a contact by its ID. Deleted contacts can be revived.
Required Permissions: contact_data
| Contact ID | Select or map the Contact ID you want to delete. |
Delete Contacts from Lists¶
Removes contacts from lists by their IDs.
Required Permissions: contact_data
| List IDs | Add the List IDs from which you want to delete the contacts. |
| All Active Contacts | Select whether you want to delete all the active contacts in the contact list. |
| Contact IDs | Add the Contact IDs you want to delete. |
| Contact List IDs | Add the Contact List IDs whose contacts you want to delete. |
Contact List¶
List Contact Lists¶
Retrieves a list of contact lists.
Required Permissions: contact_data
| Limit | Set the maximum number of contact lists Ibexa Connect should return during one execution cycle. |
Create a Contact List¶
Creates a new contact list.
Required Permissions: contact_data
| Name | Enter (map) a name for the new contact |
| Favorite | Select whether you want to mark this contact list as your favorite. |
| Description | Enter (map) the details of the contact list. |
Update a Contact List¶
Updates a contact list by its ID.
Required Permissions: contact_data
| Contact List ID | Select or map the Contact List ID you want to update. |
| Name | Enter (map) a name for the new contact |
| Favorite | Select whether you want to mark this contact list as your favorite. |
| Description | Enter (map) the details of the contact list. |
Delete a Contact List¶
Removes a contact list by its ID.
Required Permissions: contact_data
| Contact List ID | Select or map the Contact Lists you want to delete. |
Contact Tracking Report¶
Watch Contact Activities¶
Triggers by new activities of contact for specific events.
Required Permissions: contact_data
| Contact ID | Select or map the Contact ID whose contact activities you want to watch. |
| Tracking Activities List | Select or map the tracking activities list |
| Limit | Set the maximum number of Ibexa Connect should return during one execution cycle. |
List Contact Activities¶
List contact activities by their ID.
Required Permissions: contact_data
| Contact ID | Select or map the Contact ID whose activities you want to list. |
| Tracking Activities List | Select or map the activities you want to list for the contacts. |
| Limit | Set the maximum number of Ibexa Connect should return during one execution cycle. |
List Contact Action Summaries¶
List action summary for contact in email campaign activities by the contact ID.
Required Permissions: contact_data
| Contact ID | Select or map the Contact ID whose action summaries you want to list. |
| Start Date | Enter (map) the date to list the action summaries for the contacts from the specified date. See the list of supported date and time formats. |
| End Date | Enter (map) the date to list the action summaries for the contacts until the specified date. See the list of supported date and time formats. |
| Limit | Set the maximum number of action summaries Ibexa Connect should return during one execution cycle. |
Summarize Average Open and Click Rates¶
Summarize average open and click rates by the contact ID.
Required Permissions: contact_data
| Contact ID | Select or map the Contact ID whose average open and click rates you want to summarize. |
| Start Date | Enter (map) the date from which you want to summarize the average open and click rates. See the list of supported date and time formats. |
| End Date | Enter (map) the date until which you want to summarize the average open and click rates. See the list of supported date and time formats. |
Email Campaign¶
Watch Email Campaign¶
Triggers by new email campaigns.
| Limit | Set the maximum number of email campaigns Ibexa Connect should return during one execution cycle. |
List Email Campaigns¶
Retrieves a list of email campaigns.
Required Permissions: campaign_data
| Limit | Set the maximum number of email campaigns Ibexa Connect should return during one execution cycle. |
Create an Email Campaign¶
Creates a new email campaign.
Required Permissions: campaign_data
Name |
Enter (map) a name for the email campaign. |
||||||||||||||||||||||||||||
Add the Email Campaign Activities |
Add the email campaign activities: Format Type Select or map the activity format type:
|
Delete an Email Campaign¶
Removes an email campaign by its ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID you want to delete. |
Get an Email Campaign Activity¶
Retrieves details of an email campaign activity by its ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity details you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose details you want to retrieve. |
Preview an Email Campaign Activity¶
Preview an email campaign activity by its ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity you want to preview. |
| Campaign Activity ID | Select or map the Campaign Activity ID you want to preview. |
Test an Email Campaign Activity¶
Tests an email campaign activity by its ID with a daily limit of 50 test emails.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity you want to test. |
| Campaign Activity ID | Select or map the Campaign Activity ID you want to test. |
| Email Addresses | Add the email addresses to which you want to send this email campaign activity for testing. |
| Personal Message | Enter a message that you want to communicate to the recipients. |
Email Scheduling¶
List Email Campaign Activity Schedules¶
Retrieves a list of schedules of an email campaign activity by its ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity schedules you want to list. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose schedule details you want to list. |
| Limit | Set the maximum number of email campaign activity schedules Ibexa Connect should return during one execution cycle. |
Get an Email Campaign Activity Send History¶
Retrieves the send history of an email campaign activity by its ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity send history details you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose sent history details you want to retrieve. |
| Limit | Set the maximum number of email campaign activities sent history details Ibexa Connect should return during one execution cycle. |
Schedule an Email Campaign Activity¶
Schedules an email campaign activity by its ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity you want to schedule. |
| Campaign Activity ID | Select or map the Campaign Activity ID you want to schedule. |
| Schedule Date | Enter (map) the date on which you want to send the email campaign activity. See the list of supported date and time formats. |
Unschedule an Email Campaign Activity¶
Unschedules an email campaign activity by its ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity you want to unschedule. |
| Campaign Activity ID | Select or map the Campaign Activity ID you want to unschedule. |
Email Tracking Report¶
Watch Email Bounces Reports¶
Triggers by new email bounces reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity bounce reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose bounce reports details you want to watch. |
| Limit | Set the maximum number of email bounce reports Ibexa Connect should return during one execution cycle. |
Watch Email Clicks Reports¶
Triggers by new email clicks reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity click reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose click reports details you want to watch. |
| Limit | Set the maximum number of email click reports Ibexa Connect should return during one execution cycle. |
Watch Email Did Not Opens Reports¶
Triggers by new email did not open reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's emails that were not opened reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose emails that were not opened reports details you want to watch. |
| Limit | Set the maximum number of emails that were not opened reports Ibexa Connect should return during one execution cycle. |
Watch Email Forwards Reports¶
Triggers by new email forwards reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's forward reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose forward reports details you want to watch. |
| Limit | Set the maximum number of email forward reports Ibexa Connect should return during one execution cycle. |
Watch Email Opens Reports¶
Triggers by new email opens reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's open reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose open reports details you want to watch. |
| Limit | Set the maximum number of email open reports Ibexa Connect should return during one execution cycle. |
Watch Email Opt-outs Reports¶
Triggers by new email opt-outs reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's opt-out reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose opt-out reports details you want to watch. |
| Limit | Set the maximum number of email opt-out reports Ibexa Connect should return during one execution cycle. |
Watch Email Sends Reports¶
Triggers by new email send reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's sent reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose send reports details you want to watch. |
| Limit | Set the maximum number of email sent reports Ibexa Connect should return during one execution cycle. |
Watch Email Unique Opens Reports¶
Triggers by new email unique opens reports.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's unique open reports you want to watch. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose unique open reports details you want to watch. |
| Limit | Set the maximum number of email unique open reports Ibexa Connect should return during one execution cycle. |
Get Email Links Reports¶
Retrieves email links reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's link reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose link reports details you want to retrieve. |
| Limit | Set the maximum number of email link reports Ibexa Connect should return during one execution cycle. |
Get Email Bounces Reports¶
Retrieves email bounces reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's bounce reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose bounce reports details you want to retrieve. |
| Limit | Set the maximum number of email bounce reports Ibexa Connect should return during one execution cycle. |
Get Email Clicks Reports¶
Retrieves email clicks reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's click reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose click reports details you want to retrieve. |
| Limit | Set the maximum number of email click reports Ibexa Connect should return during one execution cycle. |
Get Email Did Not Opens Reports¶
Retrieves email did not opens reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's did not open reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID that did not open the report's details you want to retrieve. |
| Limit | Set the maximum number of email did not open reports Ibexa Connect should return during one execution cycle. |
Get Email Forwards Reports¶
Retrieves email forwards reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's forward reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose forward reports details you want to retrieve. |
| Limit | Set the maximum number of email forward reports Ibexa Connect should return during one execution cycle. |
Get Email Opens Reports¶
Retrieves email opens report by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's open reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose open reports details you want to retrieve. |
| Limit | Set the maximum number of email open reports Ibexa Connect should return during one execution cycle. |
Get Email Opt-outs Reports¶
Retrieves email opt-outs reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's opt-out reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose opt-out reports details you want to retrieve. |
| Limit | Set the maximum number of email opt-out reports Ibexa Connect should return during one execution cycle. |
Get Email Sends Reports¶
Retrieves email sends reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's open reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose open reports you want to retrieve. |
| Limit | Set the maximum number of email sent reports Ibexa Connect should return during one execution cycle. |
Get Email Unique Opens Reports¶
Retrieves email unique opens reports by the email campaign activity ID.
Required Permissions: campaign_data
| Campaign ID | Select or map the Campaign ID whose email campaign activity's open reports you want to retrieve. |
| Campaign Activity ID | Select or map the Campaign Activity ID whose open reports you want to retrieve. |
| Limit | Set the maximum number of unique open reports Ibexa Connect should return during one execution cycle. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Constant Contact API Documentation. |
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Contact Lists¶
The following API call returns all the contact lists from your Constant Contact account:
URL:
/v3/contact_lists
Method
:GET
Matches of the search can be found in the module's Output under Bundle > Body.
In our example, 2 contact lists were returned:
