Connectors Reference
Online email marketing solution to engage subscribers, target an audience, send beautiful, responsive emails and track results.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
CreateContactList (string listName, [internal]string output, [internal]string method) |
Create list |
|
ListContactLists ([internal]string output, [internal]string method, [internal]integer pageSize) |
List contact lists |
|
ListContacts ([internal]string output, [internal]string method, string listID) |
List contacts |
|
Create contact |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
Summary: Create list
Description: This operation is used to create a new mailing list.
Syntax:
BenchmarkEmail.CreateContactList (string listName, [internal]string output, [internal]string method)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
listName |
string (List Name) |
The name of the new list. |
True |
|
|
output |
string (output) |
Output type. |
True |
|
|
method |
string (method) |
Api method. |
True |
Returns:
Type:string
Summary: List Id
Description: Unique identifier of the list.
Summary: List contact lists
Description: Display a list of your contact lists.
Syntax:
BenchmarkEmail.ListContactLists ([internal]string output, [internal]string method, [internal]integer pageSize)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
output |
string (Output) |
Output type. |
True |
|
|
method |
string (Method) |
Api method. |
True |
|
|
pageSize |
integer (Page size) |
Maximum amount of values to return. |
True |
Returns:
Type:array of (ListContactListsResponseItem)
Summary: List contacts
Description: List the contacts in a list.
Syntax:
BenchmarkEmail.ListContacts ([internal]string output, [internal]string method, string listID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
output |
string (Output) |
Output type. |
True |
|
|
method |
string (Method) |
Api method. |
True |
|
|
listID |
string (List id) |
List to fetch contacts for. |
True |
Returns:
Type:array of (ListContactsResponseItem)
Summary: Create contact
Description: This operation is used to add a new contact to an existing mailing list.
Syntax:
BenchmarkEmail.CreateContact ([internal]string output, [internal]string method, string listID, string Email, [advanced][Optional]string FirstName, [advanced][Optional]string MiddleName, [advanced][Optional]string LastName, [advanced][Optional]string JobTitle, [advanced][Optional]string Phone, [advanced][Optional]string Notes)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
output |
string (output) |
Output type. |
True |
|
|
method |
string (method) |
Api method. |
True |
|
|
listID |
string (List id) |
Pick a list. |
True |
|
|
|
string (Email) |
Email address to add to the list (must not already be in the list). |
True |
|
|
FirstName |
string (First Name) |
First name of the new contact. |
False |
|
|
MiddleName |
string (Middle Name) |
The middle name of the new contact. |
False |
|
|
LastName |
string (Last Name) |
Last name of the new contact. |
False |
|
|
JobTitle |
string (Job Title) |
Job title of the new contact. |
False |
|
|
Phone |
string (Phone) |
Phone number of the new contact (any format). |
False |
|
|
Notes |
string (Notes) |
Additional notes related to the new contact. |
False |
Returns:
Type:integer
Summary: Success
Description: -2 if the contact already exists.
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contactcount |
integer(int32) Contact Count |
The number of contacts in this list. |
|
createdDate |
string created Date |
The date this list was created. |
|
encToken |
string encToken |
encToken |
|
id |
string Id |
Unique identifier for this list. |
|
list_description |
string Description |
Description of this list. |
|
listname |
string Name |
Given name for the list. |
|
modifiedDate |
string Modified Date |
The date of the most recent modification to the list. |
|
segment |
string segment |
segment |
|
sequence |
integer(int32) sequence |
sequence |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
createddate |
string Created Date |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
|
string |
Contact's email. |
|
firstname |
string First Name |
Contact's first name. |
|
lastname |
string Last Name |
Contact's last name. |
|
middlename |
string Middle Name |
Contact's middle name. |