Amazon Pinpoint Email Service
Amazon Pinpoint Email Service Welcome to the Amazon Pinpoint Email API Reference . This guide provides information about the Amazon Pinpoint Email API…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Pinpoint Email Service
Welcome to the Amazon Pinpoint Email API Reference . This guide provides
information about the Amazon Pinpoint Email API (version 1.0), including supported
operations, data types, parameters, and schemas.
Amazon Pinpoint is an AWS service that you
can use to engage with your customers across multiple messaging channels. You can use
Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The
Amazon Pinpoint Email API provides programmatic access to options that are unique to the
email channel and supplement the options provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon
Pinpoint Developer Guide . The Amazon Pinpoint Developer
Guide provides tutorials, code samples, and procedures that demonstrate
how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into
mobile apps and other types of applications. The guide also provides information about
key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply
to using the service.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint
for each of these Regions. For a list of all the Regions and endpoints where the API is
currently available, see AWS Service Endpoints in
the Amazon Web Services General Reference . To learn more about AWS Regions, see
Managing AWS
Regions in the Amazon Web Services General Reference .
In each Region, AWS maintains multiple Availability Zones. These Availability Zones
are physically isolated from each other, but are united by private, low-latency,
high-throughput, and highly redundant network connections. These Availability Zones
enable us to provide very high levels of availability and redundancy, while also
minimizing latency. To learn more about the number of Availability Zones that are
available in each Region, see AWS Global Infrastructure .
Endpoints 42
- GETList configuration sets
/v1/email/configuration-sets?NextToken=string&PageSize=0List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, configuration sets are groups of… - POSTCreate configuration set
/v1/email/configuration-setsCreate a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration… - GETGet configuration set event destinations
/v1/email/configuration-sets/:ConfigurationSetName/event-destinationsRetrieve a list of event destinations that are associated with a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens,… - POSTCreate configuration set event destination
/v1/email/configuration-sets/:ConfigurationSetName/event-destinationsCreate an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are… - GETList dedicated ip pools
/v1/email/dedicated-ip-pools?NextToken=string&PageSize=0List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region. - POSTCreate dedicated ip pool
/v1/email/dedicated-ip-poolsCreate a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You… - POSTCreate deliverability test report
/v1/email/deliverability-dashboard/testCreate a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email… - GETList email identities
/v1/email/identities?NextToken=string&PageSize=0Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain.… - POSTCreate email identity
/v1/email/identitiesVerifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email.… - GETGet configuration set
/v1/email/configuration-sets/:ConfigurationSetNameGet information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email,… - DELETEDelete configuration set
/v1/email/configuration-sets/:ConfigurationSetNameDelete an existing configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a… - PUTUpdate configuration set event destination
/v1/email/configuration-sets/:ConfigurationSetName/event-destinations/:EventDestinationNameUpdate the configuration of an event destination for a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks,… - DELETEDelete configuration set event destination
/v1/email/configuration-sets/:ConfigurationSetName/event-destinations/:EventDestinationNameDelete an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are… - DELETEDelete dedicated ip pool
/v1/email/dedicated-ip-pools/:PoolNameDelete a dedicated IP pool. - GETGet email identity
/v1/email/identities/:EmailIdentityProvides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM… - DELETEDelete email identity
/v1/email/identities/:EmailIdentityDeletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name. - GETGet account
/v1/email/accountObtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region. - GETGet blacklist reports
/v1/email/deliverability-dashboard/blacklist-report?BlacklistItemNames=Retrieve a list of the blacklists that your dedicated IP addresses appear on. - GETGet dedicated ip
/v1/email/dedicated-ips/:IpGet information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic… - GETGet dedicated ips
/v1/email/dedicated-ips?PoolName=string&NextToken=string&PageSize=0List the dedicated IP addresses that are associated with your Amazon Pinpoint account. - GETGet deliverability dashboard options
/v1/email/deliverability-dashboardRetrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain… - PUTPut deliverability dashboard option
/v1/email/deliverability-dashboardEnable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation,… - GETGet deliverability test report
/v1/email/deliverability-dashboard/test-reports/:ReportIdRetrieve the results of a predictive inbox placement test. - GETGet domain deliverability campaign
/v1/email/deliverability-dashboard/campaigns/:CampaignIdRetrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the… - GETGet domain statistics report
/v1/email/deliverability-dashboard/statistics-report/:Domain?StartDate=string&EndDate=stringRetrieve inbox placement and engagement rates for the domains that you use to send email. - GETList deliverability test reports
/v1/email/deliverability-dashboard/test-reports?NextToken=string&PageSize=0Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are… - GETList domain deliverability campaigns
/v1/email/deliverability-dashboard/domains/:SubscribedDomain/campaigns?StartDate=string&EndDate=string&NextToken=string&PageSize=0Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a… - GETList tags for resource
/v1/email/tags?ResourceArn=stringRetrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a… - POSTTag resource
/v1/email/tagsAdd one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint.… - DELETEUntag resource
/v1/email/tags?ResourceArn=string&TagKeys=Remove one or more tags (keys and values) from a specified resource. - PUTPut account dedicated ip warmup attributes
/v1/email/account/dedicated-ips/warmupEnable or disable the automatic warm-up feature for dedicated IP addresses. - PUTPut account sending attributes
/v1/email/account/sendingEnable or disable the ability of your account to send email. - PUTPut configuration set delivery options
/v1/email/configuration-sets/:ConfigurationSetName/delivery-optionsAssociate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types… - PUTPut configuration set reputation options
/v1/email/configuration-sets/:ConfigurationSetName/reputation-optionsEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region. - PUTPut configuration set sending options
/v1/email/configuration-sets/:ConfigurationSetName/sendingEnable or disable email sending for messages that use a particular configuration set in a specific AWS Region. - PUTPut configuration set tracking options
/v1/email/configuration-sets/:ConfigurationSetName/tracking-optionsSpecify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint. - PUTPut dedicated ip in pool
/v1/email/dedicated-ips/:Ip/poolMove a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your… - PUTPut dedicated ip warmup attributes
/v1/email/dedicated-ips/:Ip/warmup - PUTPut email identity dkim attributes
/v1/email/identities/:EmailIdentity/dkimUsed to enable or disable DKIM authentication for an email identity. - PUTPut email identity feedback attributes
/v1/email/identities/:EmailIdentity/feedbackUsed to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in… - PUTPut email identity mail from attributes
/v1/email/identities/:EmailIdentity/mail-fromUsed to enable or disable the custom Mail-From domain configuration for an email identity. - POSTSend email
/v1/email/outbound-emailsSends an email message. You can use the Amazon Pinpoint Email API to send two types of messages: Simple – A standard email message. When you create this type…
API details
- Base URL
https://email.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 42 operations on 32 pathsGET 17PUT 13POST 7DELETE 5
- Description format
- AWS Smithy model, API version
2018-07-26 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Pinpoint Email Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Pinpoint Email Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List configuration sets” (GET /v1/email/configuration-sets?NextToken=string&PageSize=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Pinpoint Email Service?
Amazon Pinpoint Email Service Welcome to the Amazon Pinpoint Email API Reference . This guide provides information about the Amazon Pinpoint Email API… It is listed under Communication and has 42 endpoints.
Who publishes the Amazon Pinpoint Email Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Pinpoint Email Service?
Requests go to https://email.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Pinpoint Email Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Pinpoint Email Service have?
42 operations on 32 paths (17 GET, 13 PUT, 7 POST, 5 DELETE).
Is forking the Amazon Pinpoint Email Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.