GET v1/MailTemplates/{mailTemplateId}

Get detailed information about an Mail Template.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
mailTemplateId

The id of the Mail Template.

integer

Required.

Body Parameters

None.

Response Information

Resource Description

The Mail Template object.


EMailTemplate
NameDescriptionTypeAdditional information
ShopId

Gets or sets the shop identifier.

integer

None.

ShopOwnerId

integer

None.

CultureId

integer

None.

CultureCode

string

None.

Code

string

Required

Max length: 50

Subject

string

Max length: 200

Content

string

Required

Max length: 1073741823

ToAddress

string

Max length: 500

CcAddress

string

Max length: 500

BccAddress

string

Max length: 500

Comment

string

Max length: 300

TemplateType

EMailTemplateTypeEnum

None.

MailKind

EMailTemplateMailKindEnum

Required

Publish

boolean

Required

Id

Gets or sets the identifier.

integer

Required

Name

Gets or sets the name.

string

Required

Max length: 50

Response Formats

application/json, text/json

Sample:
{
  "ShopId": 1,
  "ShopOwnerId": 1,
  "CultureId": 1,
  "CultureCode": "sample string 1",
  "Code": "sample string 2",
  "Subject": "sample string 3",
  "Content": "sample string 4",
  "ToAddress": "sample string 5",
  "CcAddress": "sample string 6",
  "BccAddress": "sample string 7",
  "Comment": "sample string 8",
  "TemplateType": 1,
  "MailKind": 0,
  "Publish": true,
  "Id": 10,
  "Name": "sample string 11"
}

application/xml, text/xml

Sample:
<EMailTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>10</Id>
  <Name>sample string 11</Name>
  <ShopId>1</ShopId>
  <ShopOwnerId>1</ShopOwnerId>
  <CultureId>1</CultureId>
  <CultureCode>sample string 1</CultureCode>
  <Code>sample string 2</Code>
  <Subject>sample string 3</Subject>
  <Content>sample string 4</Content>
  <ToAddress>sample string 5</ToAddress>
  <CcAddress>sample string 6</CcAddress>
  <BccAddress>sample string 7</BccAddress>
  <Comment>sample string 8</Comment>
  <TemplateType>ForCustomer</TemplateType>
  <MailKind>General</MailKind>
  <Publish>true</Publish>
</EMailTemplate>