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”
}]