Email Template
An email template record exposes an email template to REST web services.
This record is not a subrecord.
The REST API Browser includes information about the field names and field types of the email template record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s emailTemplate reference page.
For information about using email templates, including adding fields to an email template, see Email Template.
For information about using the REST API Browser, see The REST API Browser.
Record ID
The record ID for the email template REST record is emailtemplate.
The record ID for the email template REST subrecord is CrmTemplateCategorySubsidiary.
Prerequisites
You must enable the CRM feature before you can use this record through REST web services.
Exposed Elements
The following email template record elements are exposed to REST web services:
-
{addcompanyaddress} – add company address
-
{addunsubscribelink} – add unsubscribe link
-
{content} – content
-
{description} – description
-
{id} – ID
-
{isautoconverted} – is automatically converted
-
{isinactive} – is inactive
-
{isprivate} – is private
-
{mediaitem} – media item
-
{name} – name
-
{recordtype} – record type
-
{subject} – subject
-
{subscription} – subscription
Code Sample
In the following example, <accountID> represents your account ID.
HTTP request: https://<accountID>/services/rest/record/v1/emailtemplate/973
{ "name": "EmailTemplateNine", "addunsubscribelink": true, "description": "Marketing Campaign Template"
}