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
Background Int32
Centering Boolean
HeaderBackground Int32
HeaderFont String
HeaderFontSize Int32
HeaderFontStyle Int32
HeaderColor Int32
SubheaderBackground Int32
SubheaderFont String
SubheaderFontSize Int32
SubheaderFontStyle Int32
SubheaderColor Int32
BodyBackground Int32
BodyFont String
BodyFontSize Int32
BodyFontStyle Int32
BodyColor Int32
ColumnBackground Int32
ColumnFont String
ColumnFontSize Int32
ColumnFontStyle Int32
ColumnColor Int32
FooterBackground Int32
FooterFont String
FooterFontSize Int32
FooterFontStyle Int32
FooterColor Int32
IsDefault Boolean
CreationDate DateTime
ButtonBackground Int32
ButtonFont String
ButtonFontSize Int32
ButtonFontStyle Int32
ButtonColor Int32
Shared Boolean
BusinessID Int32
BusinessName String
RegionID Int32
RegionName String

 

Entity Statement

Creating a TemplateTheme
Request
POST /ssv3/odata/TemplateThemes
Content-Type     
application/json
Request body
{
“ID”:”0″,”OwnerID”:”0″,”Name”:”New Template Theme”,”BorderWidth”:
“0”,”BorderColor”:”0″,”Background”:”0″,
“Centering”:false,”HeaderBackground”:”0″,
“HeaderFont”:”Example Font”,”HeaderFontSize”:”0″,”HeaderFontStyle”:”0″,
“HeaderColor”:”0″,”SubheaderBackground”:”0″,”SubheaderFont”:
“Example Font”,”SubheaderFontSize”:”0″,”SubheaderFontStyle”:
“0”,”SubheaderColor”:”0″,”BodyBackground”:”0″,”BodyFont”:”Example Font”,”BodyFontSize”:”0″,”BodyFontStyle”:”0″,”BodyColor”:”0″,
“ColumnBackground”:”0″,”ColumnFont”:”Example Font”,”ColumnFontSize”:”0″,
“ColumnFontStyle”:”0″,”ColumnColor”:
“0”,”FooterBackground”:”0″,”FooterFont”:”Example Font”,”FooterFontSize”:
“0”,”FooterFontStyle”:”0″,”FooterColor”:
“0”,”IsDefault”:false,”CreationDate”:
“2014-11-19T12:00:00.000Z”,”ButtonBackground”:”0″,
“ButtonFont”:”Example Font”,”ButtonFontSize”:”0″,”ButtonFontStyle”:”0″,
“ButtonColor”:”0″,”Shared”:false,”BusinessID”:”0″,”BusinessName”:”Example Business Name”,”RegionID”:”0″,”RegionName”:”Example Region Name”
}
Response body
{“ID”:1,”OwnerID”:0,”Name”:”New Template Theme”,”BorderWidth”:0,
“BorderColor”:0,”Background”:0,
“Centering”:false,”HeaderBackground”:0,”HeaderFont”:”Example Font”,
“HeaderFontSize”:0,”HeaderFontStyle”:0,”HeaderColor”:0,
“SubheaderBackground”:0,”SubheaderFont”:”Example Font”,
“SubheaderFontSize”:0,”SubheaderFontStyle”:0,
“SubheaderColor”:0,”BodyBackground”:0,
“BodyFont”:”Example Font”,”BodyFontSize”:0,”BodyFontStyle”:0,
“BodyColor”:0,”ColumnBackground”:0,”ColumnFont”:”Example Font”,
“ColumnFontSize”:0,”ColumnFontStyle”:0,”ColumnColor”:0,
“FooterBackground”:0,”FooterFont”:”Example Font”,”FooterFontSize”:0,
“FooterFontStyle”:0,”FooterColor”:0,
”IsDefault”:false,”CreationDate”:”2014-11-20T12:00:00.000Z”,
“ButtonBackground”:0,”ButtonFont”:”Example Font”,”ButtonFontSize”:0,
“ButtonFontStyle”:0,”ButtonColor”:0,
“Shared”:false,”BusinessID”:0,”BusinessName”:”Example Business Name”,
“RegionID”:0,”RegionName”:”Example Region Name”
}
Deleting a TemplateTheme
  Request
  DELETE /ssv3/odata/TemplateThemes(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a TemplateTheme
  Request
  GET /ssv3/odata/TemplateThemes(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”OwnerID”:0,”Name”:”New Template Theme”,”BorderWidth”:0,”BorderColor”:0,
“Background”:0,”Centering”:false,”HeaderBackground”:0,”HeaderFont”:
“Example Font”,”HeaderFontSize”:0,”HeaderFontStyle”:0,
“HeaderColor”:0,”SubheaderBackground”:0,”SubheaderFont”:”Example Font”,”SubheaderFontSize”:0,”SubheaderFontStyle”:0,”SubheaderColor”:0,
“BodyBackground”:0,”BodyFont”:”Example Font”,”BodyFontSize”:0,”BodyFontStyle”:0,
“BodyColor”:0,”ColumnBackground”:0,”ColumnFont”:”Example Font”,
“ColumnFontSize”:0,”ColumnFontStyle”:0,”ColumnColor”:0,
“FooterBackground”:0,”FooterFont”:”Example Font”,”FooterFontSize”:0,
“FooterFontStyle”:0,”FooterColor”:0,”IsDefault”:false,
“CreationDate”:”2014-11-20T12:00:00.000Z”,”ButtonBackground”:0,
“ButtonFont”:”Example Font”,”ButtonFontSize”:0,”ButtonFontStyle”:0,”ButtonColor”:0,
“Shared”:false,”BusinessID”:0,”BusinessName”:”Example Business Name”,
“RegionID”:0,”RegionName”:”Example Region Name”
}
Updating a TemplateTheme
  Request
  PUT /ssv3/odata/TemplateThemes(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”OwnerID”:”0″,”Name”:”New Template Theme”,”BorderWidth”:
“0”,”BorderColor”:”0″,”Background”:”0″,”Centering”:false,”HeaderBackground”:
“0”,”HeaderFont”:”Example Font”,”HeaderFontSize”:”0″,”HeaderFontStyle”:”0″,
“HeaderColor”:”0″,”SubheaderBackground”:”0″,”SubheaderFont”:
“Example Font”,”SubheaderFontSize”:”0″,”SubheaderFontStyle”:”0″,
“SubheaderColor”:”0″,”BodyBackground”:”0″,”BodyFont”:”Example Font”,”BodyFontSize”:”0″,”BodyFontStyle”:”0″,”BodyColor”:”0″,
“ColumnBackground”:”0″,”ColumnFont”:”Example Font”,”ColumnFontSize”:
“0”,”ColumnFontStyle”:”0″,”ColumnColor”:”0″,”FooterBackground”:”0″,
“FooterFont”:”Example Font”,”FooterFontSize”:”0″,”FooterFontStyle”:
“0”,”FooterColor”:”0″,”IsDefault”:false,”CreationDate”:”2014-11-19T12:00:00.000Z”,”ButtonBackground”:”0″,”ButtonFont”:”Example Font”,”ButtonFontSize”:”0″,”ButtonFontStyle”:”0″,”ButtonColor”:”0″,
“Shared”:false,”BusinessID”:”0″,”BusinessName”:”Example Business Name”,
“RegionID”:”0″,”RegionName”:”Example Region Name”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all TemplateThemes
  Request
  GET /ssv3/odata/TemplateThemes
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”OwnerID”:0,”Name”:”New Template Theme”,”BorderWidth”:0,
“BorderColor”:0,”Background”:0,”Centering”:false,”HeaderBackground”:0,
“HeaderFont”:”Example Font”,”HeaderFontSize”:0,”HeaderFontStyle”:0,
“HeaderColor”:0,”SubheaderBackground”:0,”SubheaderFont”:”Example Font”,”SubheaderFontSize”:0,”SubheaderFontStyle”:0,”SubheaderColor”:
0,”BodyBackground”:0,”BodyFont”:”Example Font”,”BodyFontSize”:0,”BodyFontStyle”:
0,”BodyColor”:0,”ColumnBackground”:0,”ColumnFont”:”Example Font”,”ColumnFontSize”:0,”ColumnFontStyle”:0,”ColumnColor”:0,
“FooterBackground”:0,”FooterFont”:”Example Font”,”FooterFontSize”:0,
“FooterFontStyle”:0,”FooterColor”:0,”IsDefault”:false,”CreationDate”:”2014-11-19T12:00:00.000Z”,”ButtonBackground”:0,”ButtonFont”:”Example Font”,”ButtonFontSize”:0,”ButtonFontStyle”:0,”ButtonColor”:0,
“Shared”:false,”BusinessID”:0,”BusinessName”:”Example Business Name”,
“RegionID”:0,”RegionName”:”Example Region Name”
},{
“ID”:1,”OwnerID”:0,”Name”:”New Template Theme”,”BorderWidth”:0,”BorderColor”:0,”Background”:0,”Centering”:false,
“HeaderBackground”:0,”HeaderFont”:”Example Font”,”HeaderFontSize”:0,
“HeaderFontStyle”:0,”HeaderColor”:0,”SubheaderBackground”:0,
“SubheaderFont”:”Example Font”,”SubheaderFontSize”:0,”SubheaderFontStyle”:
0,”SubheaderColor”:0,”BodyBackground”:0,”BodyFont”:”Example Font”,”BodyFontSize”:0,”BodyFontStyle”:0,”BodyColor”:0,
“ColumnBackground”:0,”ColumnFont”:”Example Font”,”ColumnFontSize”:0,
“ColumnFontStyle”:0,”ColumnColor”:0,”FooterBackground”:0,”FooterFont”:
“Example Font”,”FooterFontSize”:0,”FooterFontStyle”:0,”FooterColor”:0,
”IsDefault”:false,”CreationDate”:”2014-11-20T12:00:00.000Z”,
“ButtonBackground”:0,”ButtonFont”:”Example Font”,”ButtonFontSize”:0,
“ButtonFontStyle”:0,”ButtonColor”:0,”Shared”:false,”BusinessID”:0,
“BusinessName”:”Example Business Name”,”RegionID”:0,
“RegionName”:”Example Region Name”
}]

 

 

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)
  Response Headers
  HTTP/1.1 204 No Content
Getting a GroupLabel
  Request
  GET /ssv3/odata/GroupLabels(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:”1″,”Label”:”New Group Label”
}
Updating a GroupLabel
  Request
  PUT /ssv3/odata/GroupLabels(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”Label”:”New Group Label”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all GroupLabels
  Request
  GET /ssv3/odata/GroupLabels
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:”0″,”Label”:”New Group Label”
},{
“ID”:”1″,”Label”:”New Group Label”
}]

 

 

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 body
{
“ID”:”0″,”Name”:”New Category”,”Enabled”:”0″
}
Response body
{
“ID”:1,”Name”:”New Category”,”Enabled”:0
}
Deleting a Category
  Request
  DELETE /ssv3/odata/Categories(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Category
  Request
  GET /ssv3/odata/Categories(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”Name”:”New Category”,”Enabled”:0
}
Updating a Category
  Request
  PUT /ssv3/odata/Categories(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”Name”:”New Category”,”Enabled”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Categories
  Request
  GET /ssv3/odata/Categories
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”Name”:”New Category”,”Enabled”:0
},{
“ID”:1,”Name”:”New Category”,”Enabled”:0
}]

 

 

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
Email String
ActiveState Boolean
CreationDate DateTime
Shared Boolean
OwnerID Int32
CatergoryID Int32
StageID Int32
Company String
WebAddress String
Title String
FileAS String
Source Int32
Notes String
Custom1 String
Custom2 String
Custom3 String
Custom4 String
Custom5 String
Custom6 String
Custom7 String
Custom8 String
Custom9 String
Custom10 String
Custom11 String
Custom12 String
Custom13 String
Custom14 String
Custom15 String
Custom16 String
Custom17 String
Custom18 String
Custom19 String
Custom20 String
BusinessID Int32
RegionID Inbt32
ListID Int32

 

Entity Statement

Creating a Contact
Request
POST /ssv3/odata/Contacts
Content-Type     
application/json
Request body
{
“ID”:”0″,”DisplayName”:”Example Display Name”,”FirstName”:
“Example First Name”,”LastName”:”Example Last Name”,”Email”:
“Example Email”,”ActiveState”:false,
“CreationDate”:”2014-01-29T12:40:26.135Z”,
“Shared”:false,”OwnerID”:”0″,”CategoryID”:”0″,”StageID”:”0″,”Company”:
“Example Company”,”WebAddress”:”Example Web Address”,”Title”:
“Example Title”,”FileAS”:””,”Source”:”0”,”Notes”:””,”Custom1”:””,
”Custom2”:””,”Custom3”:””,”Custom4”:””,”Custom5”:””,”Custom6”:””,
”Custom7”:””,”Custom8”:””,”Custom9”:””,”Custom10”:””,”Custom11”:””,
”Custom12”:””,”Custom13”:””,”Custom14”:””,”Custom15”:””,
”Custom16”:””,”Custom17”:””,”Custom18”:””,”Custom19”:””,
”Custom20”:””,”BusinessID”:”0”,”RegionID”:”0”,”ListID”:”0”
}
Response body
{
“ID”:1,”DisplayName”:”Example Display Name”,”FirstName”:
“Example First Name”,”LastName”:”Example Last Name”,
“Email”:”Example Email”,”ActiveState”:false,”CreationDate”:
“2014-02-02T11:14:06.135Z”,”Shared”:false,”OwnerID”:0,
“CategoryID”:0,”StageID”:0,”Company”:”Example Company”,”WebAddress”:
“Example Web Address”,”Title”:”Example Title”,
“FileAS”:””,”Source”:0,”Notes”:””, ”Custom1”:””, ”Custom2”:””,
”Custom3”:””, ”Custom4”:””,”Custom5”:””, ”Custom6”:””, ”Custom7”:””,
”Custom8”:””, ”Custom9”:””, ”Custom10”:””, ”Custom11”:
””, ”Custom12”:””, ”Custom13”:””, ”Custom14”:””, ”Custom15”:””,
”Custom16”:””, ”Custom17”:””, ”Custom18”:””, ”Custom19”:””,
”Custom20”:””, ”BusinessID”:0, ”RegionID”:0, ”ListID”:0
}
Deleting a Contact
  Request
  DELETE /ssv3/odata/Contacts(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Contact
  Request
  GET /ssv3/odata/Contacts(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”DisplayName”:”Example Display Name”,”FirstName”:
“Example First Name”,”LastName”:”Example Last Name”,
“Email”:”Example Email”,”ActiveState”:false,”CreationDate”:
“2014-02-02T11:14:06.135Z”,”Shared”:false,”OwnerID”:0,
“CategoryID”:0,”StageID”:0,”Company”:”Example Company”,
“WebAddress”:”Example Web Address”,”Title”:
“Example Title”,”FileAS”:””,”Source”:0,”Notes”:””, ”Custom1”:””,
”Custom2”:””,”Custom3”:””, ”Custom4”:””, ”Custom5”:””,
”Custom6”:””, ”Custom7”:””, ”Custom8”:””,
”Custom9”:””, ”Custom10”:””, ”Custom11”:””, ”Custom12”:””,
”Custom13”:””, ”Custom14”:””,”Custom15”:””, ”Custom16”:””,
”Custom17”:””, ”Custom18”:””, ”Custom19”:””, ”Custom20”:””,
”BusinessID”:0, ”RegionID”:0, ”ListID”:0
}
Updating a Contact
  Request
  PUT /ssv3/odata/Contacts(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”DisplayName”:”Example Display Name”,”FirstName”:
“Example First Name”,”LastName”:”Example Last Name”,”Email”:
“Example Email”,”ActiveState”:false,”CreationDate”:
“2014-01-29T12:40:26.135Z”,”Shared”:false,”OwnerID”:”0″,
“CategoryID”:”0″,”StageID”:”0″,”Company”:”Example Company”,
“WebAddress”:”Example Web Address”,”Title”:
“Example Title”,”FileAS”:””,”Source”:”0”,”Notes”:””,”Custom1”:””,
”Custom2”:””,”Custom3”:””,”Custom4”:””,”Custom5”:””,
”Custom6”:””,”Custom7”:””,”Custom8”:””,”Custom9”:””,”Custom10”:””,
”Custom11”:””,”Custom12”:””,”Custom13”:””,
”Custom14”:””,”Custom15”:””,”Custom16”:””,”Custom17”:””,”Custom18”:””,
”Custom19”:””,”Custom20”:””,”BusinessID”:”0”,”RegionID”:”0”,”ListID”:”0”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Contacts
  Request
  GET /ssv3/odata/Contacts
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”DisplayName”:”Example Display Name”,”FirstName”:
“Example First Name”,”LastName”:”Example Last Name”,”Email”:
“Example Email”,”ActiveState”:false,”CreationDate”:
“2014-01-29T12:40:26.135Z”,”Shared”:false,”OwnerID”:0,”CategoryID”:0,
“StageID”:0,”Company”:”Example Company”,”WebAddress”:
“Example Web Address”,”Title”:”Example Title”,
“FileAS”:””,”Source”:”0”,”Notes”:””,”Custom1”:””,”Custom2”:””,
”Custom3”:””,”Custom4”:””,”Custom5”:””,”Custom6”:””,”Custom7”:””,
”Custom8”:””,”Custom9”:””,”Custom10”:””,”Custom11”:
””,”Custom12”:””,”Custom13”:””,”Custom14”:””,”Custom15”:””,
”Custom16”:””,”Custom17”:””,”Custom18”:””,”Custom19”:””,
”Custom20”:””,”BusinessID”:”0”,”RegionID”:0,”ListID”:0
},{
“ID”:1,”DisplayName”:”Example Display Name”,”FirstName”:
“Example First Name”,”LastName”:”Example Last Name”,”Email”:”Example Email”,
“ActiveState”:false,”CreationDate”:”2014-02-02T11:14:06.135Z”,
“Shared”:false,”OwnerID”:0,”CategoryID”:0,”StageID”:0,”Company”:
“Example Company”,”WebAddress”:”Example Web Address”,”Title”:”Example Title”,”FileAS”:””,”Source”:0,”Notes”:””, ”Custom1”:””, ”Custom2”:””,
”Custom3”:””, ”Custom4”:””, ”Custom5”:””, ”Custom6”:””, ”Custom7”:””,
”Custom8”:””, ”Custom9”:””, ”Custom10”:””, ”Custom11”:””,
”Custom12”:””, ”Custom13”:””, ”Custom14”:””, ”Custom15”:””,
”Custom16”:””, ”Custom17”:””, ”Custom18”:””, ”Custom19”:””,
”Custom20”:””, ”BusinessID”:0, ”RegionID”:0, ”ListID”:0
}]

 

 

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 Additional
Information
ID Int32
FirstName String
LastName String
Name String
Email String
Phone String
Cell String
Fax String
LastLogin DateTime
UserType Int16
BusinessID Int32
RegionID Int32

 

 Entity Statement

Creating an User
Request
POST /ssv3/odata/Users
Content-Type     
application/json
Request body
{
“ID”:”0″,”FirstName”:”Example First Name”,”LastName”:”Example Last Name”,
“Name”:”New User”,”Email”:”Example Email”,”Phone”:”(000) 000-0000″,
“Cell”:”(000) 000-0000″,”Fax”:”(000) 000-0000″,”LastLogin”:”2014-12-02T12:00:00.000Z”,”UserType”:”0″,”BusinessID”:”0”,”RegionID”:”0”
}
Response body
{
“ID”:1,”FirstName”:”Example First Name”,”LastName”:”Example Last Name”,
“Name”:”New User”,”Email”:”Example Email”,”Phone”:(000) 000-0000,
“Cell”:(000) 000-0000,”Fax”:(000) 000-0000,”LastLogin”:”2014-12-03T15:42:02.125Z”,”UserType”:0,”BusinessID”:0,”RegionID”:0
}
Deleting an User
  Request
  DELETE /ssv3/odata/Users(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting an User
  Request
  GET /ssv3/odata/Users(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”FirstName”:”Example First Name”,”LastName”:”Example Last Name”,
“Name”:”New User”,”Email”:”Example Email”,”Phone”:(000) 000-0000,
“Cell”:(000) 000-0000,”Fax”:(000) 000-0000,”LastLogin”:”2014-12-03T15:42:02.125Z”,”UserType”:0,”BusinessID”:0,”RegionID”:0
}
Updating a User
  Request
  PUT /ssv3/odata/Users(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”FirstName”:”Example First Name”,”LastName”:
“Example Last Name”,”Name”:”New User”,”Email”:”Example Email”,
“Phone”:”(000) 000-0000″,”Cell”:”(000) 000-0000″,”Fax”:”(000) 000-0000″,
“LastLogin”:”2014-12-02T12:00:00.000Z”,”UserType”:”0″,
”BusinessID”:”0”,”RegionID”:”0”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Users
  Request
  GET /ssv3/odata/Users
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”FirstName”:”Example First Name”,”LastName”:”Example Last Name”,
“Name”:”New User”,”Email”:”Example Email”,”Phone”:(000) 000-0000,
“Cell”:(000) 000-0000,”Fax”:(000) 000-0000,”LastLogin”:”2014-12-02T12:00:00.000Z”,”UserType”:0,”BusinessID”:0,”RegionID”:0
},{
“ID”:1,”FirstName”:”Example First Name”,”LastName”:”Example Last Name”,
“Name”:”New User”,”Email”:”Example Email”,”Phone”:(000) 000-0000,
“Cell”:(000) 000-0000,”Fax”:(000) 000-0000,”LastLogin”:”2014-12-03T15:42:02.125Z”,”UserType”:0,”BusinessID”:0,”RegionID”:0
}]

 

 

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 Outlook.

 

Properties

Name Description Type Additional
Information
ActiveState Int16
ContentType String
CreationDate DateTime
Data Binary
ID Int32
Name String
OwnerID Int32
Shared Boolean
Size Int32
Url String
BusinessID Int32
RegionID Int32

 

Entity Statement

Creating an Image
Request
POST /ssv3/odata/Images
Content-Type     
application/json
Request body
{
“ActiveState”:”1″,”ContentType”:”Example Content Type”,”CreationDate”:”2014-12-01T12:48:51.155Z”,”Data”:”0″,”ID”:”0″,”Name”:”New Image”,”OwnerID”:”0″,”Shared”:false,”Size”:”0″,”Url”:”Example URL”,”BusinessID”:”0″,”RegionID”:”0″
}
Response body
{
“ActiveState”:1,”ContentType”:”Example Content Type”,”CreationDate”:”2014-12-02T22:08:10.155Z”,”Data”:0,”ID”:1,”Name”:”New Image”,”OwnerID”:0,”Shared”:false,”Size”:0,”Url”:”Example URL”,
“BusinessID”:0,”RegionID”:0
}
Deleting an Image
  Request
  DELETE /ssv3/odata/Images(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting an Image
  Request
  GET /ssv3/odata/Images(1)
  Content-Type     
  application/json
  Response body
  {
“ActiveState”:1,”ContentType”:”Example Content Type”,”CreationDate”:”2014-12-02T22:08:10.155Z”,”Data”:0,”ID”:1,”Name”:”New Image”,”OwnerID”:0,”Shared”:false,”Size”:0,”Url”:”Example URL”,”BusinessID”
:0,”RegionID”:0
}
Updating an Image
  Request
  PUT /ssv3/odata/Images(1)
  Content-Type     
  application/json
  Request body
  {
“ActiveState”:”1″,”ContentType”:”Example Content Type”,”CreationDate”:”2014-12-01T12:48:51.155Z”,”Data”:”0″,”ID”:”0″,”Name”:”New Image”,”OwnerID”:”0″,”Shared”:false,”Size”:”0″,”Url”:”Example URL”,”BusinessID”:”0″,”RegionID”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Images
  Request
  GET /ssv3/odata/Images
  Content-Type
  application/json
  Response body
  “value”:[{
“ActiveState”:1,”ContentType”:”Example Content Type”,”CreationDate”:”2014-12-01T12:48:51.155Z”,”Data”:0,”ID”:0,”Name”:”New Image”,”OwnerID”:0,”Shared”:false,”Size”:0,”Url”:”Example URL”,”BusinessID”
:0,”RegionID”:0
},{
“ActiveState”:1,”ContentType”:”Example Content Type”,”CreationDate”:”2014-12-02T22:08:10.155Z”,”Data”:0,”ID”:1,”Name”:”New Image”,”OwnerID”:0,”Shared”:false,”Size”:0,”Url”:”Example URL”,”BusinessID”
:0,”RegionID”:0
}]

 

 

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 redirect any future clicks from emails previously sent containing that tracked link.

 

Properties

Name Description Type Additional
Information
ID Int32
ActiveState Int16
Name String
Description String
Url String
OwnerID Int32
GUID String
Shared Boolean
CreationDate DateTime
BusinessID Int32
RegionID Int32

 

Entity Statement

Creating a Link
Request
POST /ssv3/odata/Links
Content-Type     
application/json
Request body
{
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Link”,”Description”:
“Example Description”,”Url”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T11:23:24.165Z”,”BusinessID”:”0″,”RegionID”:”0″
}
Response body
{
“ID”:1,”ActiveState”:1,”Name”:”New Link”,”Description”:
“Example Description”,”Url”:”Example URL”,”OwnerID”:0,”GUID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T13:23:24.165Z”,”BusinessID”:0,”RegionID”:0
}
Deleting a Link
  Request
  DELETE /ssv3/odata/Links(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Link
  Request
  GET /ssv3/odata/Links(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”ActiveState”:1,”Name”:”New Link”,”Description”:
“Example Description”,”Url”:”Example URL”,”OwnerID”:0,”GUID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T13:23:24.165Z”,”BusinessID”:0,”RegionID”:0
}
Updating a Link
  Request
  PUT /ssv3/odata/Links(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Link”,”Description”:
“Example Description”,”Url”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T11:23:24.165Z”,”BusinessID”:”0″,”RegionID”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Links
  Request
  GET /ssv3/odata/Links
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”ActiveState”:1,”Name”:”New Link”,”Description”:
“Example Description”,”Url”:”Example URL”,”OwnerID”:0,”GUID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T11:23:24.165Z”,”BusinessID”:0,”RegionID”:0
},{
“ID”:1,”ActiveState”:1,”Name”:”New Link”,”Description”:”Example Description”,”Url”:”Example URL”,”OwnerID”:0,”GUID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T13:23:24.165Z”,”BusinessID”:0,”RegionID”:0
}]

 

 

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

 

Entity Statement

Creating a List
Request
POST /ssv3/odata/Lists
Content-Type     
application/json
Request body
{
“ID”:”0″,”Name”:”New List”,”Description”:”Example Description”,
“IsNewsletter”:”0″,”Shared”:false, “CreationDate”:”2014-11-19T17:48:26.155Z”,”ActiveState”:”1″,”isAnonymous”:false,”BusinessID”:
“0”,”RegionID”:”0″
}
Response body
{
“ID”:1,”Name”:”New List”,”Description”:”Example Description”,
“IsNewsletter”:0,”Shared”:false, “CreationDate”:”2014-11-19T23:00:00.000Z”,”ActiveState”:1,”isAnonymous”:false,
“BusinessID”:0,”RegionID”:0
}
Deleting a List
  Request
  DELETE /ssv3/odata/Lists(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a List
  Request
  GET /ssv3/odata/Lists(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”Name”:”New List”,”Description”:”Example Description”,
“IsNewsletter”:0,”Shared”:false, “CreationDate”:”2014-11-19T23:00:00.000Z”,”ActiveState”:1,”isAnonymous”:false,
“BusinessID”:0,”RegionID”:0
}
Updating a List
  Request
  PUT /ssv3/odata/Lists(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”Name”:”New List”,”Description”:”Example Description”,
“IsNewsletter”:”0″,”Shared”:false, “CreationDate”:”2014-11-19T17:48:26.155Z”,”ActiveState”:”1″,”isAnonymous”:false,
“BusinessID”:”0″,”RegionID”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Lists
  Request
  GET /ssv3/odata/Lists
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”Name”:”New List”,”Description”:”Example Description”,
“IsNewsletter”:0,”Shared”:false, “CreationDate”:”2014-11-19T17:48:26.155Z”,”ActiveState”:1,”isAnonymous”:false,
“BusinessID”:0,”RegionID”:0
},{
“ID”:1,”Name”:”New List”,”Description”:”Example Description”,
“IsNewsletter”:0,”Shared”:false, “CreationDate”:”2014-11-19T23:00:00.000Z”,”ActiveState”:1,”isAnonymous”:false,
“BusinessID”:0,”RegionID”:0
}]

 

 

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.

 

Properties

Name Description Type Additional
Information
ID Int32
ActiveState Int16
Name String
Description String
URL String
OwnerID Int32
GUID String
Shared Boolean
CreationDate DateTime
Data Binary
ContentType String
BusinessID Int32
RegionID Int32

 

Entity Statement

Creating a SmartAttachment
Request
POST /ssv3/odata/SmartAttachments
Content-Type     
application/json
Request body
{
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Attachment”,
“Description”:””,”URL”:”Example RL”,”OwnerID”:”0″,”GUID”:
“0”,”Shared”:false,”CreationDate”:”2014-12-10T17:48:26.155Z”,
“Data”:”0″,”ContentType”:”Example Content Type”,”BusinessID”:
“0”,”RegionID”:”0″
}
Response body
{
“ID”:1,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T18:08:11.125Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
}
Deleting a SmartAttachment
  Request
  DELETE /ssv3/odata/SmartAttachments(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a SmartAttachment
  Request
  GET /ssv3/odata/SmartAttachments(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T18:08:11.125Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
}
Updating a SmartAttachment
  Request
  PUT /ssv3/odata/SmartAttachments(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T17:48:26.155Z”,”Data”:”0″,
“ContentType”:”Example Content Type”,”BusinessID”:”0″,”RegionID”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all SmartAttachments
  Request
  GET /ssv3/odata/SmartAttachments
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:0,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T17:48:26.155Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
},{
“ID”:1,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T18:08:11.125Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
}]

 

 

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.

 

Properties

Name Description Type Additional
Information
ID Int32
ActiveState Int16
Name String
Description String
OwnerID Int32
Body String
BodyBinary Binary
Icon Bitmap
LastUsed DateTime
CreationDate DateTime
Subject String
Shared Boolean
BusinessID Int32
RegionID Int32

 

Entity Statement

Creating a Template
Request
POST /ssv3/odata/Templates
Content-Type     
application/json
Request body
{
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Template”,”Description”:
“Example Description”,”OwnerID”:”0″,”Body”:”Example Body”,
“BodyBinary”:”0”, “Icon”:”Example Icon”,”LastUsed”:”2014-12-10T10:48:26.155Z”,”CreationDate”:”2014-12-01T01:00:25.155Z”,
“Subject”:”Example Subject”,”Shared”:false,”BusinessID”:”0″,”RegionID”:”0″
}
Response body
{
“ID”:1,”ActiveState”:1,”Name”:”New Template”,”Description”:”Example Description”,”OwnerID”:0,”Body”:”Example Body”,”BodyBinary”:0,
“Icon”:”Example Icon”,”LastUsed”:”2014-12-09T04:40:08.155Z”,
“CreationDate”:”2014-12-08T13:30:25.125Z”,”Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0
}
Deleting a Template
  Request
  DELETE /ssv3/odata/Templates(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Template
  Request
  GET /ssv3/odata/Templates(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”ActiveState”:1,”Name”:”New Template”,”Description”:
“Example Description”,”OwnerID”:0,”Body”:”Example Body”,
“BodyBinary”:0, “Icon”:”Example Icon”,”LastUsed”:”2014-12-09T04:40:08.155Z”,”CreationDate”:”2014-12-08T13:30:25.125Z”,
“Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0
}
Updating a Template
  Request
  PUT /ssv3/odata/Templates(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Template”,”Description”:
“Example Description”,”OwnerID”:”0″,”Body”:”Example Body”,
“BodyBinary”:”0”, “Icon”:”Example Icon”,”LastUsed”:”2014-12-10T10:48:26.155Z”,”CreationDate”:”2014-12-01T01:00:25.155Z”,
“Subject”:”Example Subject”,”Shared”:false,”BusinessID”:”0″,”RegionID”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Templates
  Request
  GET /ssv3/odata/Templates
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”ActiveState”:1,”Name”:”New Template”,”Description”:
“Example Description”,”OwnerID”:0,”Body”:”Example Body”,
“BodyBinary”:0, “Icon”:”Example Icon”,”LastUsed”:”2014-12-10T10:48:26.155Z”,”CreationDate”:”2014-12-01T01:00:25.155Z”,
“Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0
},{
“ID”:1,”ActiveState”:1,”Name”:”New Template”,”Description”:
“Example Description”,”OwnerID”:0,”Body”:”Example Body”,
“BodyBinary”:0, “Icon”:”Example Icon”,”LastUsed”:”2014-12-09T04:40:08.155Z”,”CreationDate”:”2014-12-08T13:30:25.125Z”,
“Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0
}]