Email Template
An email template is a type of message template that contains content and settings that you can define, save, and reuse in messages that you send through the email channel for any of your Amazon Pinpoint applications. You can use email templates in any type of email message that you create and send by using Amazon Pinpoint.
When you create an email template, you specify the content and settings that you want to reuse in various components of messages that are based on the template. These components, referred to as template parts, can be the message title or subject, the message body, or both. This content can be static text or personalized content that you define by using the Handlebars template system and message variables. When you send a message that’s based on a template, Amazon Pinpoint populates the message with the content and settings that you defined in the template.
The Email Template resource represents the repository of email templates that are associated with your Amazon Pinpoint account. You can use this resource to create, retrieve, update, or delete a message template for messages that you send through the email channel.
Amazon Pinpoint supports versioning for all types of message templates. When you use the Email Template resource to work with a template, you can use supported parameters to specify whether your request applies to only a specific version of the template or to the overall template. For example, if you update a template, you can specify whether you want to save your updates as a new version of the template or save them to the latest existing version of the template. To retrieve information about all the versions of a template, use the Template Versions resource.
URI
/v1/templates/
template-name
/email
HTTP methods
GET
Operation ID: GetEmailTemplate
Retrieves the content and settings of a message template for messages that are sent through the email channel.
Name | Type | Required | Description |
---|---|---|---|
template-name | String | True | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. |
Name | Type | Required | Description |
---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
Name | Type | Required | Description |
---|---|---|---|
version | String | False | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following:
|
Status code | Response model | Description |
---|---|---|
200 | EmailTemplateResponse | The request succeeded. |
400 | MessageBody | The request contains a syntax error (BadRequestException). |
403 | MessageBody | The request was denied because access to the specified resource is forbidden (ForbiddenException). |
404 | MessageBody | The request failed because the specified resource was not found (NotFoundException). |
405 | MessageBody | The request failed because the method is not allowed for the specified resource (MethodNotAllowedException). |
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). |
429 | MessageBody | The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException). |
500 | MessageBody | The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException). |
POST
Operation ID: CreateEmailTemplate
Creates a message template for messages that are sent through the email channel.
Name | Type | Required | Description |
---|---|---|---|
template-name | String | True | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. |
Name | Type | Required | Description |
---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
Status code | Response model | Description |
---|---|---|
201 | CreateTemplateMessageBody | The request succeeded and the specified resource was created. |
400 | MessageBody | The request contains a syntax error (BadRequestException). |
403 | MessageBody | The request was denied because access to the specified resource is forbidden (ForbiddenException). |
405 | MessageBody | The request failed because the method is not allowed for the specified resource (MethodNotAllowedException). |
409 | MessageBody | The request failed due to a conflict with the current state of the specified resource (ConflictException). |
429 | MessageBody | The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException). |
500 | MessageBody | The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException). |
PUT
Operation ID: UpdateEmailTemplate
Updates an existing message template for messages that are sent through the email channel.
Name | Type | Required | Description |
---|---|---|---|
template-name | String | True | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. |
Name | Type | Required | Description |
---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
Name | Type | Required | Description |
---|---|---|---|
create-new-version | String | False | Specifies whether to save the updates as a new version of the message
template. Valid values are: If you don't specify a value for this parameter, Amazon Pinpoint saves the
updates to (overwrites) the latest existing version of the template. If you
specify a value of |
version | String | False | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following:
|
Status code | Response model | Description |
---|---|---|
202 | MessageBody | The request was accepted for processing. Processing may not be complete. |
400 | MessageBody | The request contains a syntax error (BadRequestException). |
403 | MessageBody | The request was denied because access to the specified resource is forbidden (ForbiddenException). |
404 | MessageBody | The request failed because the specified resource was not found (NotFoundException). |
405 | MessageBody | The request failed because the method is not allowed for the specified resource (MethodNotAllowedException). |
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). |
429 | MessageBody | The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException). |
500 | MessageBody | The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException). |
DELETE
Operation ID: DeleteEmailTemplate
Deletes a message template for messages that were sent through the email channel.
Name | Type | Required | Description |
---|---|---|---|
template-name | String | True | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. |
Name | Type | Required | Description |
---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
Name | Type | Required | Description |
---|---|---|---|
version | String | False | The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versionsresource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following:
|
Status code | Response model | Description |
---|---|---|
202 | MessageBody | The request was accepted for processing. Processing may not be complete. |
400 | MessageBody | The request contains a syntax error (BadRequestException). |
403 | MessageBody | The request was denied because access to the specified resource is forbidden (ForbiddenException). |
404 | MessageBody | The request failed because the specified resource was not found (NotFoundException). |
405 | MessageBody | The request failed because the method is not allowed for the specified resource (MethodNotAllowedException). |
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). |
429 | MessageBody | The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException). |
500 | MessageBody | The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException). |
OPTIONS
Retrieves information about the communication requirements and options that are available for the Email Template resource.
Name | Type | Required | Description |
---|---|---|---|
template-name | String | True | The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. |
Status code | Response model | Description |
---|---|---|
200 | None | The request succeeded. |
Schemas
Request bodies
{
"TemplateDescription": "string",
"DefaultSubstitutions": "string",
"tags": {
},
"Subject": "string",
"TextPart": "string",
"HtmlPart": "string",
"RecommenderId": "string",
"Headers": [
{
"Name": "string",
"Value": "string"
}
]
}
{
"TemplateDescription": "string",
"DefaultSubstitutions": "string",
"tags": {
},
"Subject": "string",
"TextPart": "string",
"HtmlPart": "string",
"RecommenderId": "string",
"Headers": [
{
"Name": "string",
"Value": "string"
}
]
}
Response bodies
{
"CreationDate": "string",
"LastModifiedDate": "string",
"TemplateType": enum,
"TemplateName": "string",
"TemplateDescription": "string",
"DefaultSubstitutions": "string",
"Version": "string",
"tags": {
},
"Arn": "string",
"Subject": "string",
"TextPart": "string",
"HtmlPart": "string",
"RecommenderId": "string"
}
Properties
CreateTemplateMessageBody
Provides information about a request to create a message template.
Property | Type | Required | Description |
---|---|---|---|
Arn | string | False | The Amazon Resource Name (ARN) of the message template that was created. |
Message | string | False | The message that's returned from the API for the request to create the message template. |
RequestID | string | False | The unique identifier for the request to create the message template. |
EmailTemplateRequest
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
Property | Type | Required | Description |
---|---|---|---|
DefaultSubstitutions | string | False | A JSON object that specifies the default values to use 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. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values. |
Headers | Array of type MessageHeader | False | The list of MessageHeaders for the email. You can have up to 15 Headers. |
HtmlPart | string | False | The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. |
RecommenderId | string | False | The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data. |
Subject | string | False | The subject line, or title, to use in email messages that are based on the message template. |
tags | object | False | NoteAs of 22-05-2023 the tags attribute has been deprecated. After this date any value in the PUT UpdateEmailTemplate tags attribute are not processed and an error code is not returned. The POST CreateEmailTemplate tags attribute is processed. Use the Tags resource to add or modify tags. (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value. |
TemplateDescription | string | False | A custom description of the message template. |
TextPart | string | False | The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. |
EmailTemplateResponse
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
Property | Type | Required | Description |
---|---|---|---|
Arn | string | False | The Amazon Resource Name (ARN) of the message template. |
CreationDate | string | True | The date, in ISO 8601 format, when the message template was created. |
DefaultSubstitutions | string | False | 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 | string | False | The message body, in HTML format, that's used in email messages that are based on the message template. |
LastModifiedDate | string | True | The date, in ISO 8601 format, when the message template was last modified. |
RecommenderId | string | False | The unique identifier for the recommender model that's used by the message template. |
Subject | string | False | The subject line, or title, that's used in email messages that are based on the message template. |
tags | object | False | 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 | string | False | The custom description of the message template. |
TemplateName | string | True | The name of the message template. |
TemplateType | string Values: | True | The type of channel that the message template is designed for. For an email
template, this value is |
TextPart | string | False | The message body, in plain text format, that's used in email messages that are based on the message template. |
Version | string | False | 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
|
MessageBody
Provides information about an API request or response.
Property | Type | Required | Description |
---|---|---|---|
Message | string | False | The message that's returned from the API. |
RequestID | string | False | The unique identifier for the request or response. |
MessageHeader
Contains the name and value pair of an message header to add to your email. You can have up to 15 MessageHeaders. A header can contain information such as the sender, receiver, route, or timestamp.
Property | Type | Required | Description |
---|---|---|---|
Name | string | False | The name of the message header. The header name can contain up to 126 characters. |
Value | string | False | The value of the message header. The header value can contain up to 870
characters, including the length of any rendered attributes. For example if you
add the |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: