API Information

A List of API commands for PoliteMail

Articles

PoliteMail API Entity Directory
A PDF version of the API Entity Directory is available for download at the bottom of this article. Click here to go to an Odata conventions site that will assist you with creating URLs for API. Entity Description Business Business...
Download PoliteMail's Free API List Comparison Tool
This free tool is intended to help with contact management by comparing lists. Watch the tutorial video and download the .exe program at the bottom of this article. ...
About the PoliteMail API
The PoliteMail API is an ODATA Service using the RESTful architecture The PoliteMail Server application provides an Application Programmers Interface (API) which allows you to create programs to utilize PoliteMail functions, without the PoliteMail ...
Getting Connected to the PoliteMail API Section
Note that the ODATA functionality also enables you to connect to PoliteMail data using Excel PowerView or PowerBI. Using your PoliteMail client create a service account go to: PoliteMail ->Settings ->Users Note: If you do not have acces...
API / Business
Entity Description: Business can be used to define a Business Unit in an organization. The Business entity can be populated with departments, divisions, or business units in an organization (e.g. Human Resources, Marketing department, Automotive...
API/Contact
Entity Description: An email address that is created by a user will automatically be entered into PoliteMail as a Contact. A Contacts information can be added to PoliteMail manually, edited for content, added to a mailing list, or deleted from...
API/Assign a Contact to a PoliteMail List
Make a post to: https://<url>/odata/Lists(<ListID>)/AddContacts with a json body of { “contacts”: [1, 2, 3] }
API Entity Directory
PoliteMail API Entity Directory Entity Description Business Business can be used to define a Business Unit in an organization. The Business entity can be populated with departments, divisions, or business units in an organization ...
API / UserType
Entity Description: UserType is the profile information about the User that is used in PoliteMail for sending tracked email and Metric information. Properties Name Description Type Additional Information ID Int32 Na...
API / UserProfile
Entity Description: UserProfile is the profile information about the User that is used in PoliteMail for sending tracked email and Metric information. PoliteMail also defines the User a Role in the system and level of access and sharing the user...
API / User
Entity Description: User is the information about the User that is used in PoliteMail for sending email and Metric information. PoliteMail also defines the User a Role in the system and level of access and sharing the user has within the system....
API / TemplateTheme
Entity Description: TemplateTheme allows the customer to use their brand themes with PoliteMail templates and fully customize the look and feel of the template with color pallets, font selection, header and footer selection, body style, and much ...
API / Template
Entity Description: Template entity provides users the capability to design professional looking templates that can be used and modified for totally customizable email messages. The templates are saved and can be reused in other mailings. Prope...
API / SurveyQuestion
Entity Description: SurveyQuestion is a preformatted entity that can be inserted into an email message to solicit a response to a question from a recipient (e.g. Yes or No, Like or Dislike, Select 1-2 or 3, etc…). Results will be found on ...
Does PoliteMail Version 5 have any enhancements to the API?
The API in 5.0 will provide access to data elements which were previously unavailable in older versions, including enhanced Campaign, Business and Region information, as well as other new metrics calculations. Also, the API supports queryable attr...
API / SurveyAnswer
Entity Description: SurveyAnswer results will be found on the bottom of the metrics reports page. Multiple survey answers will appear on the same metrics page. Properties Name Description Type Additional Information ID In...
API / SurveyAllowedAnswer
Entity Description: SurveyAllowedAnswer allows the email recipient/survey respondent to view the results of the survey upon submitting the vote or selection. Properties Name Description Type Additional Information ID Int3...
API / Survey
Entity Description: Survey is a Q&A control that allows for Surveys such as 5 star ratings, mood type, yes or no, and multiple choice selections. The results for the Survey are found on the bottom of the metrics report section. Properties ...
API / Stage
Entity Description: Stage is defined as an area for individual contact information in the PoliteMail database. Stage includes other entities as Opt-In and Opt-Out information. Properties Name Description Type Additional Informati...
API / SocialMediaLink
Entity Description: SocialMediaLink is a tracked link that can be used in Social Media to track results (e.g. Twitter, Facebook, Google+, etc…). Properties Name Description Type Additional Information ID Int32 ...
API / SocialMediaClick
Entity Description: SocialMediaClick generates a tracked link that can be used in Social Media to track results (e.g. Twitter, Facebook, Google+, etc…). Properties Name Description Type Additional Information ID In...
API / SmartAttachment
Entity Description: PoliteMail’s SmartAttachment enables email attachments to be tracked to know who is opening the email messages. SmartAttachment is inserted into the email as a link and the file is uploaded to the Content Library. Prop...
API / SentMessage
Entity Description: SentMessage captures the metric information on the message that was sent to recipients and displays the metrics in the PoliteMail -> Results -> Messages section. Properties Name Description Type Add...
API / ScheduledSend
Entity Description: ScheduledSend functions as a delay mechanism for email messages that will be sent at a specified date and time. Properties Name Description Type Additional Information ID Int32 ...
API / Report
Entity Description: The Report entity compiles and displays aggregate information from a tracked email in the metrics section of PoliteMail. Compiled metrics such as unique mobile click-through rates, Unique URLS, multiple opens, time-to-read, e...
API / Region
Entity Description: Region works in conjunction with Business to identify and group PoliteMail Users by location (e.g. territories, State, East Coast, West Coast, North America, South America, etc….). Properties Name Descrip...
API / Read
Entity Description: Read is an entity if the PoliteMail Tracking feature. Read tracks the open rate, recipient, Browser, device used, device manufacturer, along with the Time Read (how long a recipient has the email open to Read the information)...
API / Paragraph
Entity Description: Paragraph can be used to save text (e.g. a single word, a sentence, a paragraph) in an email message and can be reused in future email messages. Paragraph can save text, hyper-links, and images for future use. Paragraph is a r...
API / OptOut
Entity Description: To be CAN-SPAM compliant with any commercial email message, OptOut can add an automated opt-out compliance footer to the PoliteMail email message or template. The OptOut footer is optional when sending email via a local email ...
API / OptIn
Entity Description: PoliteMail OptIn enables a user to add subscribers and capture email addresses and contact data via an Opt-in form. These forms are accessible via a link to the account area on the PoliteMail Server, or you may put the form co...
API / Message
Entity Description: All PoliteMail Messages distributed are tracked as groups of emails (e.g. distribution list or Templates) and a record of interactions with the recipients and the Email is stored and the metadata parsed to capture the metrics ...
API / Location
Entity Description: Location is an entity used by PoliteMail to track a recipient’s geolocation. The results will be displayed in the Metrics section of PoliteMail. Properties Name Description Type Additional Information ...
API / List
Entity Description: The List entity is a user created list containing user contacts from, an imported list, or from within the Inbox and Sent Items folders. Properties Name Description Type Additional Information ID Int32...
API / Link
Entity Description: Link allows a user to track a hyper-link or track linked text in a PoliteMail tracked email message. Tracked links in an email will be saved to a Links repository in PoliteMail for future use. Links in the repository can be ed...
API / Image
Entity Description: Image allows a user to add an Image to the PoliteMail images repository to be referenced in the email, downloaded, and displayed as an embedded image in the email. The image is hosted on the PoliteMail server which enables the...
API / GroupLabel
Entity Description: The GroupLabel entity identifies a distribution Group by name. Properties Name Description Type Additional Information ID String Label String Entity Statement if you are using vers...
API / Event
Entity Description: All PoliteMail that is distributed is tracked and a record of interactions (e.g. Open and Click counts) with the recipients and the Email is stored and the metadata parsed to capture the metrics for future analysis. Properti...
API / Email
Entity Description: All PoliteMail that is distributed is tracked and a record of interactions with the recipients and the Email is stored and the metadata parsed to capture the metrics for future analysis. Properties Name Description ...
API / DeviceCount
Entity Description: PoliteMail places a DeviceCount cookie on the recipient’s device that is used to open a tracked email. For example, PoliteMail counts the number of devices that was used to open a tracked email. (e.g. iPad, desktop, mobi...
API / Device
Entity Description: PoliteMail places a cookie on the recipient’s device that is used to open a tracked email. For example, if the Device that was used to open a tracked email was an iPad, a cookie is placed on the iPad enabling PoliteMail ...
API / CustomField
Entity Description: Custom Field allows a user to further customize the custom fields in the PoliteMail Personalization feature (e.g. salutation, birthdate, department, etc…). Custom Field may also be used for Personalization merge fields ...
API / ContactRead
Entity Description: An email that is created and sent utilizing PoliteMail, will be tracked for the time the email was opened and read, the name of the recipient, if the email is active, and was it shared with someone else. Properties Na...
API / ContactClick
Entity Description: An email that is created and sent utilizing PoliteMail, will be tracked for the time the email was opened and read, the name of the recipient, the number of URL link clicks a recipient makes in an email, the web Address, etc. ...
API / Click
Entity Description: The Click is tracked in PoliteMail with the Click-Thru Rate (CTR) metric which is the total number of unique individual recipients who have clicked (at least one link), to the total recipients the email was delivered to. (e.g....
API / Category
Entity Description: Contacts can be organized outside of mailing lists using category. Categories are assigned manually to individual contacts, or when selecting or importing a list or group of contacts. Properties Name Description ...
API / Campaign
Campaign is a group of similar email messages that have been sent with the ability to track the cumulative results of all the emails sent over time. (e.g. Monthly Newsletters, Weekly sales incentives, Marketing questionnaires, etc…). Email me...
Using the API with Message Tagging
Message Tags and the PoliteMail API Under SentMessages, there are three POST API calls that refer to Message Tags: GetByTag AddTag RemoveTag Below is some sample code to show how these might be used.  Please note that the code below is...
How can I connect PoliteMail data to PowerBI?
Connecting to PoliteMail Data via the API PoliteMail can provide you with a starting PowerBI or Excel file to get you started on connecting to your PoliteMail data via the Application Protocol Interface (API). With a few steps, you can connect you...