Connectors Reference
The emfluence Marketing Platform is a marketing automation platform that allows customers the ability to create, deploy, and track multi-channel campaigns. This connector provides access to the emfluence Marketing Platform API.
|
Status: Preview |
Tier: Premium |
Version: 1.1 |
|
Name |
Summary |
|
Search Contacts (Simple) |
|
|
Contacts-search ([internal]string Content-Type, [Optional]Contacts-searchParameterBody body) |
Search Contacts |
|
Lookup contact by email |
|
|
Contacts-save ([internal]string Content-Type, Contacts-saveParameterBody body) |
Save contact |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Search Contacts (Simple)
Description: Search contacts by simple criteria. https://apidocs.emailer.emfluence.com/v1/endpoints/contacts/search
Syntax:
emfluenceMarketingPlatform.Contacts-search-simple ([Optional]string email, [Optional]integer groupID, [Optional]boolean suppressed, [Optional]boolean held, [Optional]integer page, [Optional]string sortField, [Optional]string sortDirection)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string (Email) |
Search by email address. Use * as a wildcard, e.g. *@gmail.com |
False |
|
|
groupID |
integer (Group ID) |
Filter results by group |
False |
|
|
suppressed |
boolean (Suppressed) |
Opted out of receiving emails |
False |
|
|
held |
boolean (Held) |
Bad email address (too many bounces) |
False |
|
|
page |
integer (Page Number) |
Number of page in results to return |
False |
|
|
sortField |
string (Sort Field)Values: [contactID, email, dateModified, contactScore] |
The field to sort results by |
False |
|
|
sortDirection |
string (Sort Direction)Values: [asc, desc] |
The direction to sort results |
False |
Returns:
Type:Contacts-search-simpleResponse
Summary: Search Contacts
Description: Search contacts by various criteria. https://apidocs.emailer.emfluence.com/v1/endpoints/contacts/search
Syntax:
emfluenceMarketingPlatform.Contacts-search ([internal]string Content-Type, [Optional]Contacts-searchParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
body |
|
|
False |
Returns:
Summary: Lookup contact by email
Description: Get full details for contacts by email
Syntax:
emfluenceMarketingPlatform.Contacts-lookup (string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string (Email) |
An email address of an existing contact |
True |
Returns:
Summary: Save contact
Description: Save a single contact record. Only data for parameters passed in is saved.
Syntax:
emfluenceMarketingPlatform.Contacts-save ([internal]string Content-Type, Contacts-saveParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
code |
integer(int32)
|
code |
|
success |
integer(int32)
|
success |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
phone |
string
|
phone |
|
state |
string
|
state |
|
ipAddress |
string
|
ipAddress |
|
firstName |
string
|
firstName |
|
|
string
|
|
|
contactID |
integer(int32)
|
contactID |
|
groupIDs |
array of (GroupIDsItem)
|
groupIDs |
|
notes |
string
|
notes |
|
customerID |
string
|
customerID |
|
dateSuppressed |
string
|
dateSuppressed |
|
held |
integer(int32)
|
held |
|
country |
string
|
country |
|
lastName |
string
|
lastName |
|
userID |
integer(int32)
|
userID |
|
purl |
string
|
purl |
|
address1 |
string
|
address1 |
|
memo |
string
|
memo |
|
address2 |
string
|
address2 |
|
originalSource |
string
|
originalSource |
|
dateAdded |
string
|
dateAdded |
|
zipCode |
string
|
zipCode |
|
dateHeld |
string
|
dateHeld |
|
suppressed |
integer(int32)
|
suppressed |
|
contactScore |
|
contactScore |
|
company |
string
|
company |
|
city |
string
|
city |
|
dateOfBirth |
string
|
dateOfBirth |
|
dateModified |
string
|
dateModified |
|
lastActivityDate |
string
|
lastActivityDate |
|
title |
string
|
title |
|
fax |
string
|
fax |
|
lastClickDate |
string
|
lastClickDate |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: contactScore
Properties:
|
Name |
Type |
Summary |
|
dateModified |
string
|
dateModified |
|
percentile |
string
|
percentile |
|
value |
integer(int32)
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contactID |
integer(int32)
|
contactID |
|
|
string
|
|
|
userID |
integer(int32)
|
userID |
|
customerID |
string
|
customerID |
|
suppressed |
boolean
|
suppressed Values: [, ] |
|
held |
boolean
|
held Values: [, ] |
|
originalSource |
string
|
originalSource |
|
firstName |
string
|
firstName |
|
lastName |
string
|
lastName |
|
company |
string
|
company |
|
title |
string
|
title |
|
phone |
string
|
phone |
|
fax |
string
|
fax |
|
address1 |
string
|
address1 |
|
address2 |
string
|
address2 |
|
city |
string
|
city |
|
state |
string
|
state |
|
zipCode |
string
|
zipCode |
|
country |
string
|
country |
|
purl |
string
|
purl |
|
dateOfBirth |
string
|
dateOfBirth |
|
notes |
string
|
notes |
|
memo |
string
|
memo |
|
customFields |
|
customFields |
|
contentVariables |
|
contentVariables |
|
groupIDs |
array of (integer)
|
groupIDs |
|
removeGroupIDs |
array of (integer)
|
removeGroupIDs |
Summary:
Description: customFields
Properties:
|
Name |
Type |
Summary |
Summary:
Description: contentVariables
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
integer(int32)
|
success |
|
code |
integer(int32)
|
code |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
|
string
|
|
|
contactID |
integer(int32)
|
contactID |
|
groupIDs |
array of (GroupIDsItem)
|
groupIDs |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
code |
integer(int32)
|
code |
|
success |
integer(int32)
|
success |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
records |
array of (RecordsItem)
|
records |
|
paging |
|
paging |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
held |
integer(int32)
|
held |
|
lastName |
string
|
lastName |
|
dateAdded |
string
|
dateAdded |
|
dateModified |
string
|
dateModified |
|
userID |
integer(int32)
|
userID |
|
firstName |
string
|
firstName |
|
|
string
|
|
|
contactID |
integer(int32)
|
contactID |
|
suppressed |
integer(int32)
|
suppressed |
Summary:
Description: paging
Properties:
|
Name |
Type |
Summary |
|
rpp |
integer(int32)
|
rpp |
|
totalPages |
integer(int32)
|
totalPages |
|
prev |
string
|
prev |
|
next |
string
|
next |
|
page |
integer(int32)
|
page |
|
totalRecords |
integer(int32)
|
totalRecords |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
groupID |
integer(int32)
|
groupID |
|
suppressed |
boolean
|
suppressed Values: [, ] |
|
held |
boolean
|
held Values: [, ] |
|
contactIDs |
array of (ContactIDsItem)
|
contactIDs |
|
|
string
|
|
|
userID |
integer(int32)
|
userID |
|
customerID |
string
|
customerID |
|
company |
string
|
company |
|
title |
string
|
title |
|
phone |
string
|
phone |
|
fax |
string
|
fax |
|
city |
string
|
city |
|
state |
string
|
state |
|
zipCode |
string
|
zipCode |
|
country |
string
|
country |
|
purl |
string
|
purl |
|
fields |
string
|
fields |
|
page |
integer(int32)
|
page |
|
rpp |
integer(int32)
|
rpp |
|
sortField |
string
|
sortField Values: [contactID, email, dateModified, contactScore] |
|
sortDirection |
string
|
sortDirection Values: [asc, desc] |
|
_internal |
boolean
|
_internal Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
integer(int32)
|
success |
|
code |
integer(int32)
|
code |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
paging |
|
paging |
|
records |
array of (RecordsItem)
|
records |
Summary:
Description: paging
Properties:
|
Name |
Type |
Summary |
|
next |
string
|
next |
|
page |
integer(int32)
|
page |
|
rpp |
integer(int32)
|
rpp |
|
totalPages |
integer(int32)
|
totalPages |
|
totalRecords |
integer(int32)
|
totalRecords |
|
prev |
string
|
prev |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
firstName |
string
|
firstName |
|
dateAdded |
string
|
dateAdded |
|
dateModified |
string
|
dateModified |
|
contactID |
integer(int32)
|
contactID |
|
suppressed |
integer(int32)
|
suppressed |
|
held |
integer(int32)
|
held |
|
|
string
|
|
|
userID |
integer(int32)
|
userID |
|
lastName |
string
|
lastName |