Open documentation ↗Overview
<fullname>Amazon Pinpoint Email Service</fullname> <p>Welcome to the <i>Amazon Pinpoint Email API Reference</i>. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.</p> <p> <a href="https://aws.amazon.com/pinpoint">Amazon Pinpoint</a> 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.</p> <p>If you're new to Amazon Pinpoint, you might find it helpful to also review the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html">Amazon Pinpoint Developer Guide</a>. The <i>Amazon Pinpoint Developer Guide</i> 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.</p> <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region">AWS Service Endpoints</a> in the <i>Amazon Web Services General Reference</i>. To learn more about AWS Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing AWS Regions</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>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 <a href="http://aws.amazon.com/about-aws/global-infrastructure/">AWS Global Infrastructure</a>.</p>
Amazon Pinpoint Email Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 42 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2018-07-26
- Endpoints
- 42
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /v1/email/configuration-sets | <p>List all of the configuration sets associated with your Amazon Pinpoint account in the current region.</p> <p>In Amazon Pinpoint, <i>configuration sets</i> a |
| POST | /v1/email/configuration-sets | Create a configuration set. <i>Configuration sets</i> are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configura |
| GET | /v1/email/configuration-sets/{ConfigurationSetName}/event-destinations | <p>Retrieve a list of event destinations that are associated with a configuration set.</p> <p>In Amazon Pinpoint, <i>events</i> include message sends, deliverie |
| POST | /v1/email/configuration-sets/{ConfigurationSetName}/event-destinations | <p>Create an event destination. In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event destinatio |
| GET | /v1/email/dedicated-ip-pools | List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region. |
| POST | /v1/email/dedicated-ip-pools | Create 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 ca |
| POST | /v1/email/deliverability-dashboard/test | Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers |
| GET | /v1/email/identities | Returns 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. Thi |
| POST | /v1/email/identities | <p>Verifies 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. Befo |
| GET | /v1/email/configuration-sets/{ConfigurationSetName} | <p>Get 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 |
| DELETE | /v1/email/configuration-sets/{ConfigurationSetName} | <p>Delete an existing configuration set.</p> <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can apply to the emails you send. You |
| PUT | /v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName} | <p>Update the configuration of an event destination for a configuration set.</p> <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens, |
| DELETE | /v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName} | <p>Delete an event destination.</p> <p>In Amazon Pinpoint, <i>events</i> include message sends, deliveries, opens, clicks, bounces, and complaints. <i>Event des |
| DELETE | /v1/email/dedicated-ip-pools/{PoolName} | Delete a dedicated IP pool. |
| GET | /v1/email/identities/{EmailIdentity} | Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authenticati |
| DELETE | /v1/email/identities/{EmailIdentity} | Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name. |
| GET | /v1/email/account | Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region. |
| GET | /v1/email/deliverability-dashboard/blacklist-report#BlacklistItemNames | Retrieve a list of the blacklists that your dedicated IP addresses appear on. |
| GET | /v1/email/dedicated-ips/{IP} | Get 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 war |
| GET | /v1/email/dedicated-ips | List the dedicated IP addresses that are associated with your Amazon Pinpoint account. |
| GET | /v1/email/deliverability-dashboard | <p>Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gai |
| PUT | /v1/email/deliverability-dashboard | <p>Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, |
| GET | /v1/email/deliverability-dashboard/test-reports/{ReportId} | Retrieve the results of a predictive inbox placement test. |
| GET | /v1/email/deliverability-dashboard/campaigns/{CampaignId} | Retrieve 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 D |
| GET | /v1/email/deliverability-dashboard/statistics-report/{Domain}#StartDate&EndDate | Retrieve inbox placement and engagement rates for the domains that you use to send email. |
| GET | /v1/email/deliverability-dashboard/test-reports | Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, |
| GET | /v1/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns#StartDate&EndDate | Retrieve 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 domain |
| GET | /v1/email/tags#ResourceArn | Retrieve a list of the tags (keys and values) that are associated with a specified resource. A <i>tag</i> is a label that you optionally define and associate wi |
| PUT | /v1/email/account/dedicated-ips/warmup | Enable or disable the automatic warm-up feature for dedicated IP addresses. |
| PUT | /v1/email/account/sending | Enable or disable the ability of your account to send email. |
| PUT | /v1/email/configuration-sets/{ConfigurationSetName}/delivery-options | Associate 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 of |
| PUT | /v1/email/configuration-sets/{ConfigurationSetName}/reputation-options | Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region. |
| PUT | /v1/email/configuration-sets/{ConfigurationSetName}/sending | Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region. |
| PUT | /v1/email/configuration-sets/{ConfigurationSetName}/tracking-options | Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint. |
| PUT | /v1/email/dedicated-ips/{IP}/pool | <p>Move a dedicated IP address to an existing dedicated IP pool.</p> <note> <p>The dedicated IP address that you specify must already exist, and must be associa |
| PUT | /v1/email/dedicated-ips/{IP}/warmup | <p/> |
| PUT | /v1/email/identities/{EmailIdentity}/dkim | Used to enable or disable DKIM authentication for an email identity. |
| PUT | /v1/email/identities/{EmailIdentity}/feedback | <p>Used 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 |
| PUT | /v1/email/identities/{EmailIdentity}/mail-from | Used to enable or disable the custom Mail-From domain configuration for an email identity. |
| POST | /v1/email/outbound-emails | <p>Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:</p> <ul> <li> <p> <b>Simple</b> – A standard email message. |
| POST | /v1/email/tags | <p>Add one or more tags (keys and values) to a specified resource. A <i>tag</i> is a label that you optionally define and associate with a resource in Amazon Pi |
| DELETE | /v1/email/tags#ResourceArn&TagKeys | Remove one or more tags (keys and values) from a specified resource. |
Questions
Does the Amazon Pinpoint Email Service API need an API key?
Yes. The Amazon Pinpoint Email Service API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Pinpoint Email Service API support HTTPS?
Yes, the Amazon Pinpoint Email Service API is served over HTTPS.
How many endpoints does the Amazon Pinpoint Email Service API have?
Its OpenAPI description lists 42 endpoints in version 2018-07-26. All of them are shown on this page.
What are alternatives to the Amazon Pinpoint Email Service API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).