PoliteMail (Preview)

Measure results with powerful email metrics, including opens, read-time and click through rates plus valuable analytics to help you gain the insights you need to improve your communications.

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
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
username securestring

The username for this api

password securestring

The password for this api

PoliteMail domain string

The domain where you access PoliteMail.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds
Frequency of trigger polls1120 seconds

Actions

Add emails to a list

This action allows you to add contacts to a PoliteMail list by email address.

Create a campaign

This action will create a Campaign.

Create a contact

This action will create a contact.

Create a list

This action allows you to create a list.

Create a template

This action allows you to create a template.

Get contacts from a list

This action will retrieve all contacts from a list.

Remove emails from list

This action allows you to remove contacts from a PoliteMail list by email address.

Send a message

This allows you to send a tracked message using PoliteMail.

Upload a SmartAttachment

This action allows you to upload a file as a Smart Attachment.

Upload an image

This action will upload an image to the PoliteMail server.

Add emails to a list

This action allows you to add contacts to a PoliteMail list by email address.

Parameters

Name Key Required Type Description
Select List
id True integer

key: id

emails
emails string

key: id

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value boolean

Create a campaign

This action will create a Campaign.

Parameters

Name Key Required Type Description
Name
Name True string

This action will create a Campaign.

Description
Description string

This action will create a Campaign.

Select Owner
OwnerID integer

This action will create a Campaign.

Shared
Shared boolean

This action will create a Campaign.

Select Business
BusinessID integer

This action will create a Campaign.

Select Region
RegionID integer

This action will create a Campaign.

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value integer

Create a contact

This action will create a contact.

Parameters

Name Key Required Type Description
FirstName
FirstName string

This action will create a contact.

LastName
LastName string

This action will create a contact.

Email
Email True string

This action will create a contact.

Select Owner
OwnerID integer

This action will create a contact.

Shared
Shared boolean

This action will create a contact.

Select Business
BusinessID integer

This action will create a contact.

Select Region
RegionID integer

This action will create a contact.

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value integer

Create a list

This action allows you to create a list.

Parameters

Name Key Required Type Description
Name
Name True string

This action allows you to create a list.

Description
Description string

This action allows you to create a list.

Select Owner
OwnerID integer

This action allows you to create a list.

Shared
Shared boolean

This action allows you to create a list.

Select Business
BusinessID integer

This action allows you to create a list.

Select Region
RegionID integer

This action allows you to create a list.

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value integer

Create a template

This action allows you to create a template.

Parameters

Name Key Required Type Description
Name
Name True string

This action allows you to create a template.

Subject
Subject string

This action allows you to create a template.

Description
Description string

This action allows you to create a template.

File
BodyBinary True binary

This action allows you to create a template.

Body
Body string

This action allows you to create a template.

Select Owner
OwnerID integer

This action allows you to create a template.

Shared
Shared boolean

This action allows you to create a template.

Select Business
BusinessID integer

This action allows you to create a template.

Select Region
RegionID integer

This action allows you to create a template.

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value integer

Get contacts from a list

This action will retrieve all contacts from a list.

Parameters

Name Key Required Type Description
Select List
id True integer

key: id

Expand
$expand string

Expands related entities inline.

Select
$select string

Selects which properties to include in the response.

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value array of Contact

Remove emails from list

This action allows you to remove contacts from a PoliteMail list by email address.

Parameters

Name Key Required Type Description
Select List
id True integer

key: id

emails
emails string

key: id

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value boolean

Send a message

This allows you to send a tracked message using PoliteMail.

Parameters

Name Key Required Type Description
Select Campaign
Campaign integer

Specify the campaign this message is a part of

To True string

Specify email addresses separated by semicolons

Subject True string

Specify the subject of the mail

Body True string

Specify the body of the mail

From (Send as)
From True string

First Last first.last@politemail.com

CC string

Specify email addresses separated by semicolons

BCC string

Specify email addresses separated by semicolons

Importance
Importance integer

Specify the message importance

Sensitivity
Sensitivity string

Specify the message sensitivity

Is HTML
IsHTML boolean

Specify the campaign this message is a part of

Send Mode
SendMode integer

Specify Send Mode for this message: 1-individual, 2-Anonymous, 3-Aggregate Modes

Send Later
SendLater date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value boolean

Upload a SmartAttachment

This action allows you to upload a file as a Smart Attachment.

Parameters

Name Key Required Type Description
Name
Name True string

This action allows you to upload a file as a Smart Attachment.

ContentType
ContentType string

This action allows you to upload a file as a Smart Attachment.

Data
Data True binary

This action allows you to upload a file as a Smart Attachment.

Select Owner
OwnerID integer

This action allows you to upload a file as a Smart Attachment.

Shared
Shared boolean

This action allows you to upload a file as a Smart Attachment.

Privacy
Privacy integer

This action allows you to upload a file as a Smart Attachment.

Select Business
BusinessID integer

This action allows you to upload a file as a Smart Attachment.

Select Region
RegionID integer

This action allows you to upload a file as a Smart Attachment.

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value integer

Upload an image

This action will upload an image to the PoliteMail server.

Parameters

Name Key Required Type Description
Name
Name True string

This action will upload an image to the PoliteMail server.

Content Type
ContentType string

This action will upload an image to the PoliteMail server.

Data
Data True binary

This action will upload an image to the PoliteMail server.

Select Owner
OwnerID integer

This action will upload an image to the PoliteMail server.

Shared
Shared boolean

This action will upload an image to the PoliteMail server.

Privacy
Privacy integer

This action will upload an image to the PoliteMail server.

Select Business
BusinessID integer

This action will upload an image to the PoliteMail server.

Select Region
RegionID integer

This action will upload an image to the PoliteMail server.

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value integer

Triggers

When there is a new contact

Triggers when a new contact is created

When there is a new contact

Triggers when a new contact is created

Returns

Name Path Type Description
odata.metadata
odata.metadata string
value
value array of Contact

Definitions

Contact

Name Path Type Description
id
id integer
displayName
displayName string
firstName
firstName string
lastName
lastName string
email
email string
activeState
activeState boolean
creationDate
creationDate date-time
shared
shared boolean
ownerID
ownerID integer
categoryID
categoryID integer
stageID
stageID integer
company
company string
webAddress
webAddress string
title
title string
fileAs
fileAs string
source
source integer
notes
notes string
custom1
custom1 string
custom2
custom2 string
custom3
custom3 string
custom4
custom4 string
custom5
custom5 string
custom6
custom6 string
custom7
custom7 string
custom8
custom8 string
custom9
custom9 string
custom10
custom10 string
custom11
custom11 string
custom12
custom12 string
custom13
custom13 string
custom14
custom14 string
custom15
custom15 string
custom16
custom16 string
custom17
custom17 string
custom18
custom18 string
custom19
custom19 string
custom20
custom20 string
businessID
businessID integer
regionID
regionID integer
lastChangedDate
lastChangedDate date-time