BrandTemplate

Supported Calls

create(), query(), retrieve(), update(), upsert(), getDeleted(), getUpdated()

Special Access Rules

Customer Portal users cannot access this object.

Fields

Field	Field Type	Field Properties	Description
Description	string	Create Filter Nillable Update	Description of the letterhead. Limited to 1000 characters.
DeveloperName	string	Create Filter Nillable Update	The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package and the changes are reflected in a subscriber's organization. Label is Letterhead Unique Name.
IsActive	boolean	Create Defaulted on create Filter idLookup Update	Indicates whether the letterhead is available for use (`true`) or not (`false`). Label is Active.
Name	string	Create Filter Update	Label of the template as it appears in the Salesforce.comuser interface. Limited to 255 characters. Label is Brand Template Name.
NamespacePrefix	string	Filter Nillable	The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The limit is 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. This field cannot be accessed unless the logged-in user has the “Customize Application” permission.
Value	textarea	Create Update	The contents of the letterhead, in HTML, including any logos.

Usage

Use this object to brand EmailTemplates with your letterhead. You can also set a brand template to active or inactive. For example, if you have five different marketing brands, you can maintain each different brand in one template, and assign to the appropriate EmailTemplate.