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, mobile device, etc…)  In other words, the total number of iPads, mobile devices, and desktops that were […]

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.   Properties Name Description Type Additional Information ID String OpenCount Int32 ClickCount Int32 EventDate DateTime   Entity […]

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 more.   Properties Name Description Type Additional Information ID Int32 OwnerID Int32 Name String BorderWidth Int32 BorderColor Int32 […]

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 Creating a GroupLabel Request POST /ssv3/odata/GroupLabels Content-Type      application/json Request body { “ID”:”0″,”Label”:”New Group Label” } Response body { “ID”:”1″,”Label”:”New Group Label” } Deleting a GroupLabel   Request   DELETE /ssv3/odata/GroupLabels(1) […]

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 Type Additional Information ID Int32 Name String Enabled Int32   Entity Statement Creating a Category Request POST /ssv3/odata/Categories Content-Type      application/json Request […]

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 PoliteMail. Properties Name Description Type Additional Information ID Int32 DisplayName String FirstName String LastName String […]

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. There are three User types: Administrator, Manager, and User.   Properties Name Description Type […]

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 PoliteMail server to process email sends faster than using the Copy/Paste routine in […]

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 edited. By changing the actual URL associated with a link, it will […]

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 Name String Description String IsNewsletter Int32 Shared Boolean CreationDate DateTime ActiveState Int16 IsAnonymous Boolean GUID String BusinessID Int32 RegionID Int32 […]

Latest Tweets

  • Loading...