PoliteMail (Preview)

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.

Note:

  • This is a Premium connector.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 120 seconds

Creating a connection

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

username
securestring
The username for this api
password
securestring
The password for this api
PoliteMail domain
string
The domain where you access PoliteMail.

Actions

Add emails to a list

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

Required Parameters

Select List
integer
key: id

Optional Parameters

emails
string

Returns

odata.metadata
string
This action allows you to add contacts to a PoliteMail list by email address.
value
boolean
This action allows you to add contacts to a PoliteMail list by email address.

Create a campaign

This action will create a Campaign.

Required Parameters

Name
string

Optional Parameters

Description
string
Select Owner
integer
Shared
boolean
Select Business
integer
Select Region
integer

Returns

odata.metadata
string
This action will create a Campaign.
value
integer
This action will create a Campaign.

Create a contact

This action will create a contact.

Required Parameters

Email
string

Optional Parameters

FirstName
string
LastName
string
Select Owner
integer
Shared
boolean
Select Business
integer
Select Region
integer

Returns

odata.metadata
string
This action will create a contact.
value
integer
This action will create a contact.

Create a list

This action allows you to create a list.

Required Parameters

Name
string

Optional Parameters

Description
string
Select Owner
integer
Shared
boolean
Select Business
integer
Select Region
integer

Returns

odata.metadata
string
This action allows you to create a list.
value
integer
This action allows you to create a list.

Create a template

This action allows you to create a template.

Required Parameters

Name
string
File
binary

Optional Parameters

Subject
string
Description
string
Body
string
Select Owner
integer
Shared
boolean
Select Business
integer
Select Region
integer

Returns

odata.metadata
string
This action allows you to create a template.
value
integer
This action allows you to create a template.

Get contacts from a list

This action will retrieve all contacts from a list.

Required Parameters

Select List
integer
key: id

Optional Parameters

Expand
string
Expands related entities inline.
Select
string
Selects which properties to include in the response.

Returns

odata.metadata
string
This action will retrieve all contacts from a list.
value
array of Contact
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.

Required Parameters

Select List
integer
key: id

Optional Parameters

emails
string

Returns

odata.metadata
string
This action allows you to remove contacts from a PoliteMail list by email address.
value
boolean
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.

Required Parameters

string
Specify email addresses separated by semicolons
string
Specify the subject of the mail
string
Specify the body of the mail
From (Send as)
string
First Last <first.last@politemail.com>

Optional Parameters

Select Campaign
integer
Specify the campaign this message is a part of
string
Specify email addresses separated by semicolons
string
Specify email addresses separated by semicolons
Importance
integer
Specify the message importance
Sensitivity
string
Specify the message sensitivity
Is HTML
boolean
Send Mode
integer
Specify Send Mode for this message: 1-individual, 2-Anonymous, 3-Aggregate Modes
Send Later
date-time
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Returns

odata.metadata
string
This allows you to send a tracked message using PoliteMail.
value
boolean
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.

Required Parameters

Name
string
Data
binary

Optional Parameters

ContentType
string
Select Owner
integer
Shared
boolean
Privacy
integer
Select Business
integer
Select Region
integer

Returns

odata.metadata
string
This action allows you to upload a file as a Smart Attachment.
value
integer
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.

Required Parameters

Name
string
Data
binary

Optional Parameters

Content Type
string
Select Owner
integer
Shared
boolean
Privacy
integer
Select Business
integer
Select Region
integer

Returns

odata.metadata
string
This action will upload an image to the PoliteMail server.
value
integer
This action will upload an image to the PoliteMail server.

Triggers

When there is a new contact

Triggers when a new contact is created

Returns

odata.metadata
string
Triggers when a new contact is created
value
array of Contact
Triggers when a new contact is created

Definitions

Contact

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