Managing message templates - Amazon Pinpoint

Managing message templates

The Message templates page on the Amazon Pinpoint console provides a single location for you to create, view, and manage all the message templates for your Amazon Pinpoint account in the current AWS Region. By using this page, you can manage your message templates as a single collection. This can help you design consistent messages and reuse content more easily and effectively. You can use this page to perform management tasks such as viewing and editing templates, and copying, deleting, and creating templates.

For information about creating a message template, see Creating email templates, Creating push notification templates, Creating SMS templates, or Creating voice templates, depending on the type of template that you want to create.

For information about viewing and managing versions of templates, see Managing versions of message templates.

Viewing your collection of message templates

The Message templates page displays a list of all the message templates for your Amazon Pinpoint account in the current AWS Region. To browse the list more easily or find specific templates quickly, you can sort and filter the list, choose which columns to display, and change other display settings for the list.

To view your collection of message templates

  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. In the navigation pane, choose Message templates. The Message templates page opens and displays the number of templates in your collection and a list of those templates.

  3. To customize the list or find a specific template quickly, choose any of the following options:

    • To sort the list by a specific type of value, click the column heading for that value. To change the sort order from ascending to descending or vice versa, click the column heading again.

    • To apply a filter that displays only a specific type of template, use the channel selector at the top of the page to choose the channel. To remove the filter, choose All message channels from the channel selector.

    • To apply a filter that displays only those templates whose names contain specific text, enter the text in the Search box above the list. To remove the filter, choose X in the Search box.

    • To change the number of templates that are displayed in the list, choose the settings icon at the top of the page. Then, for Page size, choose the number of templates that you want to display, and choose Save changes.

    • To add or remove columns from the list, choose the settings icon at the top of the page. Then, for Choose visible columns, turn each column on or off, and choose Save changes.

Opening a message template

By using the Message templates page, you can quickly find and open a specific message template to view the contents of the template and information about the template. For example, you can view current and previous versions of the template, and determine when the template was last updated. After you open a template, you can also edit the template.

To open a message template

  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. In the navigation pane, choose Message templates.

  3. On the Message templates page, choose the template that you want to open. The template page opens and displays information about the template. It also displays the contents of the active version of the template.

  4. To view a different version of the template, use the version selector under Template details to choose the version that you want to view.

Editing a message template

You can open a message template for editing in two ways: while you're authoring a message that uses the template, and by using the Message templates page. This topic explains how to open and edit a template by using the Message templates page.

If you edit a template, Amazon Pinpoint might apply your changes to existing messages that use the template and haven't been sent yet, such as campaign messages that are scheduled to be sent at a later time. This depends on whether you edit the active version of the template and how you configured the messages that use the template. For more information, see Managing versions of message templates.

To edit a message template

  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. In the navigation pane, choose Message templates.

  3. On the Message templates page, choose the template that you want to edit. The template page opens and displays information about the template. It also displays the contents and settings for the active version of the template.

  4. Choose Edit.

  5. Under Template details, use the version selector to choose the version of the template that you want to use as a starting point for your changes. If you choose the most recent version of the template, you can save your changes directly to that version of the template. Otherwise, you can save your changes as a new version of the template.

  6. Make the changes that you want. You can change any of the template's content or settings, except the name of the template. To change the name of the template, you can create a copy of the template, save the copy with the name that you want, and then optionally delete the original template.

  7. When you finish making changes, do one of the following:

    • To save your changes as a new version of the template, choose Save as new version. To help ensure that your changes don't affect any existing messages, we recommend that you choose this option.

    • To save your changes as an update to the most recent version of the template, choose Update version. This option is available only if you chose the most recent version of the template in step 5. If you choose this option, your changes might affect existing messages that use the template.

Copying a message template

To quickly create a new message template that's similar to an existing template, you can create a copy of the template. You can then edit the template copy without changing the original template.

To copy a message template

  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. In the navigation pane, choose Message templates.

  3. On the Message templates page, select the check box next to the template that you want to copy.

  4. On the Actions menu, choose Duplicate.

  5. For Template name, enter a name for the template copy. The name has to begin with a letter or number. It can contain up to 128 characters. The characters can be letters, numbers, underscores (_), or hyphens (‐).

  6. When you finish entering the name, choose Duplicate template. The template page opens and displays all the content and settings for the active version of the template that you copied.

  7. (Optional) To change the template copy, choose Edit, make the changes that you want, and then choose Save as new version.

Deleting a message template

If you want to remove a message template from Amazon Pinpoint completely, you can delete the template. If you delete a template, it doesn't affect any existing messages that use the template, such as campaign messages that are scheduled to be sent at a later time.

Warning

If you delete a template, Amazon Pinpoint deletes all versions, content, and settings for the template. In addition, the template becomes unavailable for all future messages. You can't recover a template after you delete it.

To delete a message template

  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. In the navigation pane, choose Message templates.

  3. On the Message templates page, select the check box next to each template that you want to delete.

  4. On the Actions menu, choose Delete.