Add unsubscribe headers to email using Amazon Pinpoint
Note
Before you can use email headers, you must set up an email orchestration sending
role if you are sending email from a campaign or a journey. For direct send email,
you must have permissions for ses:SendEmail
and
ses:SendRawEmail
. For more information, see Creating an email orchestration sending role in the
Amazon Pinpoint User Guide.
Including an unsubscribe link in your email is a best practice, and in some countries it's a legal requirement. To add a One-click unsubscribe link add the following headers:
-
Set the header Name to
List-Unsubscribe
and set Value to your unsubscribe link. The link must support HTTP POST requests to process the recipients unsubscribe request. -
Set the header Name to
List-Unsubscribe-Post
and set Value toList-Unsubscribe=One-Click
.
You can add up to 15 headers to an email message. For a list of supported headers see Amazon SES header fields in the Amazon Simple Email Service Developer Guide.
The following example shows how to send an email message with unsubscribe headers using the AWS Command Line Interface. For more information about configuring the AWS CLI, see Configure the AWS CLI in the AWS Command Line Interface User Guide.
In the following command, do the following:
-
Replace
AppId
with your application id. -
Replace
richard_roe@example.com
with the recipient's email address. -
Replace
https://example.com/unsub
with your unsubscribe link. -
Replace
example123456
with a unique identifier for the recipient.
aws pinpoint send-messages --application-id
AppId
--message-request '{ "Addresses": { "richard_roe@example.com
": { "ChannelType": "EMAIL" } }, "MessageConfiguration": { "EmailMessage": { "Substitutions": { "url": [ "https://example.com/unsub
" ], "id1": [ "/example123456
" ] }, "SimpleEmail": { "TextPart": { "Data": "Sample email message with an subscribe header", "Charset": "UTF-8" }, "Subject": { "Data": "Hello", "Charset": "UTF-8" }, "Headers": [ { "Name": "List-Unsubscribe", "Value": "{{url}}{{id1}}" }, { "Name": "List-Unsubscribe-Post", "Value": "List-Unsubscribe=One-Click" } ] } } } }'