POST api/v1/emailtemplates

Request Information

URI Parameters

None.

Body Parameters

EmailTemplateDetails
NameDescriptionTypeAdditional information
EmailTemplateId

globally unique identifier

None.

EmailTemplateName

string

Required

String length: inclusive between 0 and 100

EmailTemplateKeyName

string

Required

String length: inclusive between 0 and 100

Description

string

None.

LanguageId

integer

None.

FromAddress

string

Required

String length: inclusive between 0 and 256

ReplyToAddresses

string

String length: inclusive between 0 and 256

Subject

string

Required

String length: inclusive between 0 and 256

HtmlBody

string

None.

TextBody

string

None.

Id

globally unique identifier

None.

CanUpdateRecord

boolean

None.

CanDeleteRecord

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "EmailTemplateId": "cb87694e-5056-4d37-904d-65aa3d44e14b",
  "EmailTemplateName": "sample string 2",
  "EmailTemplateKeyName": "sample string 3",
  "Description": "sample string 4",
  "LanguageId": 5,
  "FromAddress": "sample string 6",
  "ReplyToAddresses": "sample string 7",
  "Subject": "sample string 8",
  "HtmlBody": "sample string 9",
  "TextBody": "sample string 10",
  "Id": "cb87694e-5056-4d37-904d-65aa3d44e14b",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:
{"EmailTemplateId":"cb87694e-5056-4d37-904d-65aa3d44e14b","EmailTemplateName":"sample string 2","EmailTemplateKeyName":"sample string 3","Description":"sample string 4","LanguageId":5,"FromAddress":"sample string 6","ReplyToAddresses":"sample string 7","Subject":"sample string 8","HtmlBody":"sample string 9","TextBody":"sample string 10","Id":"cb87694e-5056-4d37-904d-65aa3d44e14b","CanUpdateRecord":true,"CanDeleteRecord":true}

application/xml, text/xml

Sample:
<EmailTemplateDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Emails">
  <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
  <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
  <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">cb87694e-5056-4d37-904d-65aa3d44e14b</Id>
  <Description>sample string 4</Description>
  <EmailTemplateId>cb87694e-5056-4d37-904d-65aa3d44e14b</EmailTemplateId>
  <EmailTemplateKeyName>sample string 3</EmailTemplateKeyName>
  <EmailTemplateName>sample string 2</EmailTemplateName>
  <FromAddress>sample string 6</FromAddress>
  <HtmlBody>sample string 9</HtmlBody>
  <LanguageId>5</LanguageId>
  <ReplyToAddresses>sample string 7</ReplyToAddresses>
  <Subject>sample string 8</Subject>
  <TextBody>sample string 10</TextBody>
</EmailTemplateDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmailTemplateDetails
NameDescriptionTypeAdditional information
EmailTemplateId

globally unique identifier

None.

EmailTemplateName

string

Required

String length: inclusive between 0 and 100

EmailTemplateKeyName

string

Required

String length: inclusive between 0 and 100

Description

string

None.

LanguageId

integer

None.

FromAddress

string

Required

String length: inclusive between 0 and 256

ReplyToAddresses

string

String length: inclusive between 0 and 256

Subject

string

Required

String length: inclusive between 0 and 256

HtmlBody

string

None.

TextBody

string

None.

Id

globally unique identifier

None.

CanUpdateRecord

boolean

None.

CanDeleteRecord

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "EmailTemplateId": "a1cec818-29ec-46e1-a64e-94c94fe1cb53",
  "EmailTemplateName": "sample string 2",
  "EmailTemplateKeyName": "sample string 3",
  "Description": "sample string 4",
  "LanguageId": 5,
  "FromAddress": "sample string 6",
  "ReplyToAddresses": "sample string 7",
  "Subject": "sample string 8",
  "HtmlBody": "sample string 9",
  "TextBody": "sample string 10",
  "Id": "a1cec818-29ec-46e1-a64e-94c94fe1cb53",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:
{"EmailTemplateId":"a1cec818-29ec-46e1-a64e-94c94fe1cb53","EmailTemplateName":"sample string 2","EmailTemplateKeyName":"sample string 3","Description":"sample string 4","LanguageId":5,"FromAddress":"sample string 6","ReplyToAddresses":"sample string 7","Subject":"sample string 8","HtmlBody":"sample string 9","TextBody":"sample string 10","Id":"a1cec818-29ec-46e1-a64e-94c94fe1cb53","CanUpdateRecord":true,"CanDeleteRecord":true}

application/xml, text/xml

Sample:
<EmailTemplateDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Emails">
  <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
  <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
  <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">a1cec818-29ec-46e1-a64e-94c94fe1cb53</Id>
  <Description>sample string 4</Description>
  <EmailTemplateId>a1cec818-29ec-46e1-a64e-94c94fe1cb53</EmailTemplateId>
  <EmailTemplateKeyName>sample string 3</EmailTemplateKeyName>
  <EmailTemplateName>sample string 2</EmailTemplateName>
  <FromAddress>sample string 6</FromAddress>
  <HtmlBody>sample string 9</HtmlBody>
  <LanguageId>5</LanguageId>
  <ReplyToAddresses>sample string 7</ReplyToAddresses>
  <Subject>sample string 8</Subject>
  <TextBody>sample string 10</TextBody>
</EmailTemplateDetails>