Connectors Reference
dotdigital Engagement Cloud is a SaaS omnichannel marketing automation platform helping you create, send, and test data-driven campaigns.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Get account information |
|
|
Get address books |
|
|
CreateAddressBook (integer Region, CreateAddressBookParameterBody body) |
Create address book |
|
CreateContact (string Address Book, integer Region, CreateContactParameterBody body) |
Create contact |
|
Get all campaigns |
|
|
SendEmailCampaign (integer Region, SendEmailCampaignParameterBody body) |
Send email campaign |
|
GetsAllContacts |
|
|
Get contact data fields |
|
|
Send transactional email using a triggered campaign |
|
|
Gets all programs |
|
|
CreateProgramEnrolment (integer Region, CreateProgramEnrolmentParameterBody body) |
Create program enrolment |
|
SendSmsMessage (string TelephoneNumber, integer Region, SendSmsMessageParameterBody body) |
Send SMS message |
|
Bulk creates or bulk updates contacts in an address book |
|
|
GetContactsImportStatus |
|
|
GetContactsImportReport |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
File Data |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get account information
Description: Gets a summary of information about the current status of the account
Syntax:
EngagementCloud.GetAccountInformation ()
Returns:
Type:GetAccountInformationResponse
Summary: Get address books
Description: Gets all address books
Syntax:
EngagementCloud.GetAddressBooks (integer Region)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer
|
|
True |
Returns:
Type:array of (GetAddressBooksResponseItem)
Summary: Create address book
Description: Creates an address book
Syntax:
EngagementCloud.CreateAddressBook (integer Region, CreateAddressBookParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer (Region)Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
|
|
body |
CreateAddressBookParameterBody
|
|
True |
Returns:
Type:CreateAddressBookResponse
Summary: Create contact
Description: Creates a contact
Syntax:
EngagementCloud.CreateContact (string Address Book, integer Region, CreateContactParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Address Book |
string (Address Book) |
Select the address book or input the address book ID |
True |
|
|
Region |
integer (Region)Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
|
|
body |
|
|
True |
Returns:
Summary: Get all campaigns
Description: Gets all campaigns
Syntax:
EngagementCloud.GetsAllCampaigns (integer Region)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer Values: [, , ] |
|
True |
Returns:
Type:array of (GetsAllCampaignsResponseItem)
Summary: Send email campaign
Description: Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send
Syntax:
EngagementCloud.SendEmailCampaign (integer Region, SendEmailCampaignParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer (Region)Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
|
|
body |
SendEmailCampaignParameterBody
|
|
True |
Returns:
Type:SendEmailCampaignResponse
Summary: GetsAllContacts
Description: Gets a list of all contacts in the account
Syntax:
EngagementCloud.GetsAllContacts (integer Region)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer Values: [, , ] |
|
True |
Returns:
Type:array of (GetsAllContactsResponseItem)
Summary: Get contact data fields
Description: List all contact data fields within the account
Syntax:
EngagementCloud.GetContactDataFields (integer Region)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
Returns:
Type:array of (GetContactDataFieldsResponseItem)
Summary: Send transactional email using a triggered campaign
Description: Sends a transactional email using a triggered campaign
Syntax:
EngagementCloud.SendTransactionalEmailUsingTriggeredCampagin (integer Region, SendTransactionalEmailUsingTriggeredCampaginParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer (Region)Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
|
|
body |
SendTransactionalEmailUsingTriggeredCampaginParameterBody
|
|
True |
Returns:
Type:SendTransactionalEmailUsingTriggeredCampaginResponse
Summary: Gets all programs
Description: Gets all programs
Syntax:
EngagementCloud.GetsAllPrograms (integer Region)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
Returns:
Type:array of (GetsAllProgramsResponseItem)
Summary: Create program enrolment
Description: Creates a program enrolment
Syntax:
EngagementCloud.CreateProgramEnrolment (integer Region, CreateProgramEnrolmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Region |
integer (Region)Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
|
|
body |
CreateProgramEnrolmentParameterBody
|
|
True |
Returns:
Type:CreateProgramEnrolmentResponse
Summary: Send SMS message
Description: Sends a single SMS message
Syntax:
EngagementCloud.SendSmsMessage (string TelephoneNumber, integer Region, SendSmsMessageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
TelephoneNumber |
string (Mobile phone) |
Phone numbers must be prefixed by their international code for example +44 for the UK |
True |
|
|
Region |
integer (Region)Values: [, , ] |
Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC) |
True |
|
|
body |
|
|
True |
Returns:
Summary: Bulk creates or bulk updates contacts in an address book
Description: Bulk creates or bulk updates contacts in an address book
Syntax:
EngagementCloud.BulkContactsImport (string Address Book, file filedata)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Address Book |
string (Address Book) |
Select the address book or input the address book ID |
True |
|
|
filedata |
(File Data) |
File containing the data records to import. |
True |
Returns:
Type:BulkContactsImportResponse
Summary: GetContactsImportStatus
Description: Gets the import status of a previously started contact import
Syntax:
EngagementCloud.GetContactsImportStatus (string Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Id |
string (Import ID) |
The ID of the import |
True |
Returns:
Type:GetContactsImportStatusResponse
Summary: GetContactsImportReport
Description: Gets a report with statistics about what was successfully imported and what was unable to be imported
Syntax:
EngagementCloud.GetContactsImportReport (string Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Id |
string (Import ID) |
The ID of the import |
True |
Returns:
Type:GetContactsImportReportResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The name of the address book you are creating |
|
visibility |
string
|
All address books are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to. Values: [Private, Public] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contacts |
integer(int32)
|
contacts |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
|
visibility |
string
|
visibility |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
dataFields |
array of (DataFieldsItem)
|
dataFields |
|
|
string
|
The email address for the subscriber |
|
emailType |
string
|
Values: [PlainText, Html] |
|
optInType |
string
|
Values: [Unknown, Single, Double, VerifiedDouble] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
key |
string
|
Engagement Cloud contact data field |
|
value |
string
|
Value to be imported |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
dataFields |
array of (DataFieldsItem)
|
Data field |
|
|
string
|
|
|
emailType |
string
|
emailType |
|
id |
integer(int32)
|
id |
|
optInType |
string
|
optInType |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
key |
string
|
key |
|
value |
string
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
AddressBooks |
array of (integer(int32))
|
AddressBooks |
|
Contacts |
array of (integer(int32))
|
Contacts |
|
ProgramID |
integer(int32)
|
Select the program or input the program ID |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
addressBooks |
array of (integer(int32))
|
addressBooks |
|
contacts |
array of (integer(int32))
|
contacts |
|
dateCreated |
string
|
dateCreated |
|
id |
string
|
id |
|
programId |
integer(int32)
|
programId |
|
status |
string
|
status |
Summary: File Data
Description: File containing the data records to import.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
|
properties |
array of (PropertiesItem)
|
properties |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
type |
string
|
type |
|
value |
string
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contacts |
integer(int32)
|
contacts |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
|
visibility |
string
|
visibility |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
defaultValue |
string
|
defaultValue |
|
name |
string
|
name |
|
type |
string
|
type |
|
visibility |
string
|
visibility |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fromAddress |
|
fromAddress |
|
fromName |
string
|
fromName |
|
htmlContent |
string
|
htmlContent |
|
id |
integer(int32)
|
id |
|
isSplitTest |
boolean
|
isSplitTest |
|
name |
string
|
name |
|
plainTextContent |
string
|
plainTextContent |
|
replyAction |
string
|
replyAction |
|
replyToAddress |
string
|
replyToAddress |
|
status |
string
|
status |
|
subject |
string
|
subject |
Summary:
Description: fromAddress
Properties:
|
Name |
Type |
Summary |
|
|
string
|
|
|
id |
integer(int32)
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
dataFields |
string
|
dataFields |
|
|
string
|
|
|
emailType |
string
|
emailType |
|
id |
integer(int32)
|
id |
|
optInType |
string
|
optInType |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
dateCreated |
string
|
dateCreated |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
AddressBookIDs |
array of (integer(int32))
|
AddressBookIDs |
|
CampaignID |
integer(int32)
|
Select the campaign or input the campaign ID |
|
ContactIDs |
array of (integer(int32))
|
ContactIDs |
|
SendDate |
string(date-time)
|
Follow the format YYYY-MM-DDTHH:MM:SS (UTC) |
|
SplitTestOptions |
string
|
The object that includes the following fields for specifying the options of a split test: TestMetric - string ("Opens", or "Clicks"), TestPercentage - int, and TestPeriodHours - int |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
addressBookIds |
array of (integer(int32))
|
addressBookIds |
|
campaignId |
integer(int32)
|
campaignId |
|
contactIds |
array of (integer(int32))
|
contactIds |
|
id |
string
|
id |
|
sendDate |
string
|
sendDate |
|
splitTestOptions |
|
splitTestOptions |
|
status |
string
|
status |
Summary:
Description: splitTestOptions
Properties:
|
Name |
Type |
Summary |
|
TestMetric |
string
|
TestMetric |
|
TestPercentage |
integer(int32)
|
TestPercentage |
|
TestPeriodHours |
integer(int32)
|
TestPeriodHours |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Message |
string
|
Messages that are over 160 characters or contain 'Unicode' can incur extra costs |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CampaignID |
integer(int32)
|
The campaign selected must be of type “triggered” |
|
PersonalizationValues |
array of (PersonalizationValuesItem)
|
PersonalizationValues |
|
ToAddresses |
array of (string)
|
ToAddresses |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
The placeholder name of the personalisation for example FIRSTNAME |
|
Value |
string
|
The value to be used in the personalisation for example select dynamic content FIRSTNAME |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |