Property | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body |
The user-entered body content of the email message, in HTML format. |
||||||||||||||||||||||||||||||||||
buttonText |
If a call-to-action button is displayed in the email, this is the text label that will appear on the button. |
||||||||||||||||||||||||||||||||||
created read-only |
The date on which the entity was created. |
||||||||||||||||||||||||||||||||||
emailTemplateType |
The constant ShootProof identifier for the email template type.
|
||||||||||||||||||||||||||||||||||
headline |
If a headline is displayed in the email, this is the text of that headline. |
||||||||||||||||||||||||||||||||||
htmlEmail read-only |
The full HTML email template, complete with in-lined CSS, headers, and footers. This may be used to render a representation of the email message, allowing the studio user an opportunity to preview their message before sending it. |
||||||||||||||||||||||||||||||||||
htmlEmailCss read-only |
CSS styles that may be used to style a representation of the email message, providing the studio user an opportunity to preview their message before sending it. |
||||||||||||||||||||||||||||||||||
id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||||||||||||||||||||||
links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||||||||||||||||||||||
name |
The name of this email template. |
||||||||||||||||||||||||||||||||||
resourceType nullable read-only |
If present, this describes the type of resource represented by this email template. |
||||||||||||||||||||||||||||||||||
subject |
The email subject line to use for this template. |
||||||||||||||||||||||||||||||||||
type |
The type of object represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"properties": {
"body": {
"description": "The user-entered body content of the email message, in HTML format.",
"type": "string"
},
"buttonText": {
"description": "If a call-to-action button is displayed in the email, this is the text\nlabel that will appear on the button.",
"type": "string"
},
"created": {
"$ref": "#/components/schemas/Signature/properties/created"
},
"emailTemplateType": {
"$ref": "#/components/schemas/EmailTemplateType/properties/emailTemplateType"
},
"headline": {
"description": "If a headline is displayed in the email, this is the text of that\nheadline.",
"type": "string"
},
"htmlEmail": {
"description": "The full HTML email template, complete with in-lined CSS, headers,\nand footers. This may be used to render a representation of the email\nmessage, allowing the studio user an opportunity to preview their\nmessage before sending it.",
"readOnly": true,
"type": "string"
},
"htmlEmailCss": {
"description": "CSS styles that may be used to style a representation of the email\nmessage, providing the studio user an opportunity to preview their\nmessage before sending it.",
"readOnly": true,
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The name of this email template.",
"type": "string"
},
"resourceType": {
"allOf": [
{
"readOnly": true
},
{
"$ref": "#/components/schemas/EmailTemplateType/properties/resourceType"
}
]
},
"subject": {
"description": "The email subject line to use for this template.",
"type": "string"
},
"type": {
"description": "The type of object represented.",
"enum": [
"email-template"
],
"type": "string"
}
},
"title": "Email Template",
"type": "object"
}