EmailTemplateResponse is a JSON Structure definition published by Amazon Pinpoint, describing 13 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-email-template-response-structure.json",
"name": "EmailTemplateResponse",
"description": "Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.",
"type": "object",
"properties": {
"Arn": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The Amazon Resource Name (ARN) of the message template."
}
]
},
"CreationDate": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The date, in ISO 8601 format, when the message template was created."
}
]
},
"DefaultSubstitutions": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable."
}
]
},
"HtmlPart": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The message body, in HTML format, that's used in email messages that are based on the message template."
}
]
},
"LastModifiedDate": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The date, in ISO 8601 format, when the message template was last modified."
}
]
},
"RecommenderId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier for the recommender model that's used by the message template."
}
]
},
"Subject": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The subject line, or title, that's used in email messages that are based on the message template."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/MapOf__string"
},
{
"description": "A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value."
}
]
},
"TemplateDescription": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The custom description of the message template."
}
]
},
"TemplateName": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The name of the message template."
}
]
},
"TemplateType": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateType"
},
{
"description": "The type of channel that the message template is designed for. For an email template, this value is EMAIL."
}
]
},
"TextPart": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The message body, in plain text format, that's used in email messages that are based on the message template."
}
]
},
"Version": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request."
}
]
}
},
"required": [
"LastModifiedDate",
"CreationDate",
"TemplateName",
"TemplateType"
]
}