Engagement Cloud (Preview)

dotdigital Engagement Cloud is a SaaS omnichannel marketing automation platform helping you create, send, and test data-driven campaigns.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name dotdigital support
URL https://dotdigital.com/contact-us/
Email support@dotdigital.com
Connector Metadata
Publisher dotdigital
Website https://dotdigital.com/
Privacy policy https://dotdigital.com/trust-center/gdpr/
Categories Marketing;Communication

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
password securestring The password for this api True
username securestring The username for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection150270 seconds

Actions

Bulk creates or bulk updates contacts in an address book

Bulk creates or bulk updates contacts in an address book

Create address book

Creates an address book

Create contact

Creates a contact

Create program enrolment

Creates a program enrolment

GetContactsImportReport

Gets a report with statistics about what was successfully imported and what was unable to be imported

GetContactsImportStatus

Gets the import status of a previously started contact import

Send email campaign

Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send

Send SMS message

Sends a single SMS message

Send transactional email using a triggered campaign

Sends a transactional email using a triggered campaign

Bulk creates or bulk updates contacts in an address book

Bulk creates or bulk updates contacts in an address book

Parameters

Name Key Required Type Description
Address Book
Address Book True string

Select the address book or input the address book ID

File Data
filedata True file

File containing the data records to import.

Returns

Create address book

Creates an address book

Parameters

Name Key Required Type Description
Region
Region True integer

Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC)

Address book name
name True string

The name of the address book you are creating

Visibility
visibility string

All address books are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to.

Returns

Name Path Type Description
contacts
contacts integer

contacts

id
id integer

id

name
name string

name

visibility
visibility string

visibility

Create contact

Creates a contact

Parameters

Name Key Required Type Description
Address Book
Address Book True string

Select the address book or input the address book ID

Region
Region True integer

Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC)

key
key string

Engagement Cloud contact data field

value
value string

Value to be imported

Email
email True string

The email address for the subscriber

Email type
emailType string
Opt-in type
optInType string

Returns

Name Path Type Description
dataFields
dataFields array of object

Data field

key
dataFields.key string

key

value
dataFields.value string

value

email
email string

email

emailType
emailType string

emailType

id
id integer

id

optInType
optInType string

optInType

status
status string

status

Create program enrolment

Creates a program enrolment

Parameters

Name Key Required Type Description
Region
Region True integer

Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC)

Address books
AddressBooks integer

Select the address book or type the address book ID

Contacts
Contacts integer

Select the contact emails or a dynamic content type “Email”

Program
ProgramID True integer

Select the program or input the program ID

Returns

Name Path Type Description
addressBooks
addressBooks array of integer

addressBooks

contacts
contacts array of integer

contacts

dateCreated
dateCreated string

dateCreated

id
id string

id

programId
programId integer

programId

status
status string

status

GetContactsImportReport

Gets a report with statistics about what was successfully imported and what was unable to be imported

Parameters

Name Key Required Type Description
Import ID
Id True string

The ID of the import

Returns

GetContactsImportStatus

Gets the import status of a previously started contact import

Parameters

Name Key Required Type Description
Import ID
Id True string

The ID of the import

Returns

Send email campaign

Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send

Parameters

Name Key Required Type Description
Region
Region True integer

Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC)

Address books
AddressBookIDs integer

Select the address book or input the address book ID

Campaign
CampaignID True integer

Select the campaign or input the campaign ID

Contacts
ContactIDs integer

Select the contact emails or a dynamic content type 'Email'

Send date
SendDate date-time

Follow the format YYYY-MM-DDTHH:MM:SS (UTC)

Returns

Name Path Type Description
addressBookIds
addressBookIds array of integer

addressBookIds

campaignId
campaignId integer

campaignId

contactIds
contactIds array of integer

contactIds

id
id string

id

sendDate
sendDate string

sendDate

TestMetric
splitTestOptions.TestMetric string

TestMetric

TestPercentage
splitTestOptions.TestPercentage integer

TestPercentage

TestPeriodHours
splitTestOptions.TestPeriodHours integer

TestPeriodHours

status
status string

status

Send SMS message

Sends a single SMS message

Parameters

Name Key Required Type Description
Mobile phone
TelephoneNumber True string

Phone numbers must be prefixed by their international code for example +44 for the UK

Region
Region True integer

Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC)

Message
Message True string

Messages that are over 160 characters or contain 'Unicode' can incur extra costs

Returns

Send transactional email using a triggered campaign

Sends a transactional email using a triggered campaign

Parameters

Name Key Required Type Description
Region
Region True integer

Engagement Cloud account region (1 for EMEA, 2 for NA, 3 for APAC)

Campaign
CampaignID True integer

The campaign selected must be of type “triggered”

Name
Name string

The placeholder name of the personalisation for example FIRSTNAME

Value
Value string

The value to be used in the personalisation for example select dynamic content FIRSTNAME

To addresses
ToAddresses string

Select the contact emails or a dynamic content type “Email”

Returns