PUT api/v1/emailtemplates/{emailTemplateId}
Updates the specified emailTemplate.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| emailTemplateId |
The emailTemplate identifier. |
globally unique identifier |
Required |
Body Parameters
The emailTemplate details.
EmailTemplateDetails| Name | Description | Type | Additional 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": "44ea5ec0-f1e9-4c57-941e-b1fa1ce209e3",
"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": "44ea5ec0-f1e9-4c57-941e-b1fa1ce209e3",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"EmailTemplateId":"44ea5ec0-f1e9-4c57-941e-b1fa1ce209e3","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":"44ea5ec0-f1e9-4c57-941e-b1fa1ce209e3","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">44ea5ec0-f1e9-4c57-941e-b1fa1ce209e3</Id> <Description>sample string 4</Description> <EmailTemplateId>44ea5ec0-f1e9-4c57-941e-b1fa1ce209e3</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:
Response Information
Resource Description
EmailTemplateDetails| Name | Description | Type | Additional 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": "8479d6d5-8d9e-4c0d-b967-e7423c4a1656",
"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": "8479d6d5-8d9e-4c0d-b967-e7423c4a1656",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"EmailTemplateId":"8479d6d5-8d9e-4c0d-b967-e7423c4a1656","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":"8479d6d5-8d9e-4c0d-b967-e7423c4a1656","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">8479d6d5-8d9e-4c0d-b967-e7423c4a1656</Id> <Description>sample string 4</Description> <EmailTemplateId>8479d6d5-8d9e-4c0d-b967-e7423c4a1656</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>