POST 17.0/app/marketing/emaildesigner/preview

Description

Generates a preview of a marketing email using the settings passed in the request

URI Parameters

None.

MarketingEmailDesignerPreviewRequest
Name Description Type Additional information
EmailType

MarketingEmailType

None.
BackgroundColour

integer

None.
BodyColour

integer

None.
BodyTextColour

integer

None.
MenuColour

integer

None.
MenuItemColour

integer

None.
MenuItemTextColour

integer

None.
MenuItemSeperatorColour

integer

None.
DetailBorderColour

integer

None.
DetailBackgroundColour

integer

None.
DetailTextColour

integer

None.
HeadingColour

integer

None.
FooterDividerColour

integer

None.
FooterTextColour

integer

None.
SocialMediaIconStyle

byte

None.
FacebookUrl

string

None.
TwitterUrl

string

None.
LinkedInUrl

string

None.
InstagramUrl

string

None.

application/json, text/json
Sample: 
{
  "emailType": 0,
  "backgroundColour": 1,
  "bodyColour": 2,
  "bodyTextColour": 3,
  "menuColour": 4,
  "menuItemColour": 5,
  "menuItemTextColour": 6,
  "menuItemSeperatorColour": 7,
  "detailBorderColour": 8,
  "detailBackgroundColour": 9,
  "detailTextColour": 10,
  "headingColour": 11,
  "footerDividerColour": 12,
  "footerTextColour": 13,
  "socialMediaIconStyle": 64,
  "facebookUrl": "sample string 15",
  "twitterUrl": "sample string 16",
  "linkedInUrl": "sample string 17",
  "instagramUrl": "sample string 18"
}

application/xml, text/xml
Sample: 
<MarketingEmailDesignerPreviewRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BackgroundColour>1</BackgroundColour>
  <BodyColour>2</BodyColour>
  <BodyTextColour>3</BodyTextColour>
  <MenuColour>4</MenuColour>
  <MenuItemColour>5</MenuItemColour>
  <MenuItemTextColour>6</MenuItemTextColour>
  <MenuItemSeperatorColour>7</MenuItemSeperatorColour>
  <DetailBorderColour>8</DetailBorderColour>
  <DetailBackgroundColour>9</DetailBackgroundColour>
  <DetailTextColour>10</DetailTextColour>
  <HeadingColour>11</HeadingColour>
  <FooterDividerColour>12</FooterDividerColour>
  <FooterTextColour>13</FooterTextColour>
  <SocialMediaIconStyle>64</SocialMediaIconStyle>
  <FacebookUrl>sample string 15</FacebookUrl>
  <TwitterUrl>sample string 16</TwitterUrl>
  <LinkedInUrl>sample string 17</LinkedInUrl>
  <InstagramUrl>sample string 18</InstagramUrl>
  <EmailType>PropertyBulletin</EmailType>
</MarketingEmailDesignerPreviewRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

Html of the generated preview

MarketingEmailDesignerPreviewResponse
Name Description Type Additional information
Body

string

None.

application/json, text/json
Sample: 
{
  "body": "sample string 1"
}

application/xml, text/xml
Sample: 
<MarketingEmailDesignerPreviewResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Body>sample string 1</Body>
</MarketingEmailDesignerPreviewResponse>