POST api/v1/emailtemplates

Inserts the specified emailTemplate details.

Request Information

URI Parameters

None.

Body Parameters

The emailTemplate details.

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.

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": "6f061ca4-a46b-4ba4-ba1e-57b409e4e179",
  "EmailTemplateName": "sample string 2",
  "EmailTemplateKeyName": "sample string 3",
  "Description": "sample string 4",
  "FromAddress": "sample string 5",
  "ReplyToAddresses": "sample string 6",
  "Subject": "sample string 7",
  "HtmlBody": "sample string 8",
  "TextBody": "sample string 9",
  "Id": "6f061ca4-a46b-4ba4-ba1e-57b409e4e179",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:
{"EmailTemplateId":"6f061ca4-a46b-4ba4-ba1e-57b409e4e179","EmailTemplateName":"sample string 2","EmailTemplateKeyName":"sample string 3","Description":"sample string 4","FromAddress":"sample string 5","ReplyToAddresses":"sample string 6","Subject":"sample string 7","HtmlBody":"sample string 8","TextBody":"sample string 9","Id":"6f061ca4-a46b-4ba4-ba1e-57b409e4e179","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">6f061ca4-a46b-4ba4-ba1e-57b409e4e179</Id>
  <Description>sample string 4</Description>
  <EmailTemplateId>6f061ca4-a46b-4ba4-ba1e-57b409e4e179</EmailTemplateId>
  <EmailTemplateKeyName>sample string 3</EmailTemplateKeyName>
  <EmailTemplateName>sample string 2</EmailTemplateName>
  <FromAddress>sample string 5</FromAddress>
  <HtmlBody>sample string 8</HtmlBody>
  <ReplyToAddresses>sample string 6</ReplyToAddresses>
  <Subject>sample string 7</Subject>
  <TextBody>sample string 9</TextBody>
</EmailTemplateDetails>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EmailTemplateDetails'.

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.

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": "ffe1f2b4-0e83-440a-94ed-75b72db094a9",
  "EmailTemplateName": "sample string 2",
  "EmailTemplateKeyName": "sample string 3",
  "Description": "sample string 4",
  "FromAddress": "sample string 5",
  "ReplyToAddresses": "sample string 6",
  "Subject": "sample string 7",
  "HtmlBody": "sample string 8",
  "TextBody": "sample string 9",
  "Id": "ffe1f2b4-0e83-440a-94ed-75b72db094a9",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:
{"EmailTemplateId":"ffe1f2b4-0e83-440a-94ed-75b72db094a9","EmailTemplateName":"sample string 2","EmailTemplateKeyName":"sample string 3","Description":"sample string 4","FromAddress":"sample string 5","ReplyToAddresses":"sample string 6","Subject":"sample string 7","HtmlBody":"sample string 8","TextBody":"sample string 9","Id":"ffe1f2b4-0e83-440a-94ed-75b72db094a9","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">ffe1f2b4-0e83-440a-94ed-75b72db094a9</Id>
  <Description>sample string 4</Description>
  <EmailTemplateId>ffe1f2b4-0e83-440a-94ed-75b72db094a9</EmailTemplateId>
  <EmailTemplateKeyName>sample string 3</EmailTemplateKeyName>
  <EmailTemplateName>sample string 2</EmailTemplateName>
  <FromAddress>sample string 5</FromAddress>
  <HtmlBody>sample string 8</HtmlBody>
  <ReplyToAddresses>sample string 6</ReplyToAddresses>
  <Subject>sample string 7</Subject>
  <TextBody>sample string 9</TextBody>
</EmailTemplateDetails>