Skip to content

Amazon Pinpoint API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Doc Engage API - Amazon Pinpoint API

Amazon Pinpoint is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 119 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2016-12-01
Endpoints
119
Spec updated
2020-04-23

Endpoints

MethodPathWhat it does
GET/v1/appsRetrieves information about all the applications that are associated with your Amazon Pinpoint account.
POST/v1/apps<p>Creates an application.</p>
GET/v1/apps/{application-id}/campaignsRetrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
POST/v1/apps/{application-id}/campaignsCreates a new campaign for an application or updates the settings of an existing campaign for an application.
GET/v1/templates/{template-name}/emailRetrieves the content and settings of a message template for messages that are sent through the email channel.
POST/v1/templates/{template-name}/emailCreates a message template for messages that are sent through the email channel.
PUT/v1/templates/{template-name}/emailUpdates an existing message template for messages that are sent through the email channel.
DELETE/v1/templates/{template-name}/emailDeletes a message template for messages that were sent through the email channel.
GET/v1/apps/{application-id}/jobs/exportRetrieves information about the status and settings of all the export jobs for an application.
POST/v1/apps/{application-id}/jobs/exportCreates an export job for an application.
GET/v1/apps/{application-id}/jobs/importRetrieves information about the status and settings of all the import jobs for an application.
POST/v1/apps/{application-id}/jobs/importCreates an import job for an application.
GET/v1/templates/{template-name}/inappRetrieves the content and settings of a message template for messages sent through the in-app channel.
POST/v1/templates/{template-name}/inappCreates a new message template for messages using the in-app message channel.
PUT/v1/templates/{template-name}/inappUpdates an existing message template for messages sent through the in-app message channel.
DELETE/v1/templates/{template-name}/inappDeletes a message template for messages sent using the in-app message channel.
GET/v1/apps/{application-id}/journeysRetrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
POST/v1/apps/{application-id}/journeysCreates a journey for an application.
GET/v1/templates/{template-name}/pushRetrieves the content and settings of a message template for messages that are sent through a push notification channel.
POST/v1/templates/{template-name}/pushCreates a message template for messages that are sent through a push notification channel.
PUT/v1/templates/{template-name}/pushUpdates an existing message template for messages that are sent through a push notification channel.
DELETE/v1/templates/{template-name}/pushDeletes a message template for messages that were sent through a push notification channel.
GET/v1/recommendersRetrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
POST/v1/recommendersCreates an Amazon Pinpoint configuration for a recommender model.
GET/v1/apps/{application-id}/segmentsRetrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
POST/v1/apps/{application-id}/segmentsCreates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an applicati
GET/v1/templates/{template-name}/smsRetrieves the content and settings of a message template for messages that are sent through the SMS channel.
POST/v1/templates/{template-name}/smsCreates a message template for messages that are sent through the SMS channel.
PUT/v1/templates/{template-name}/smsUpdates an existing message template for messages that are sent through the SMS channel.
DELETE/v1/templates/{template-name}/smsDeletes a message template for messages that were sent through the SMS channel.
GET/v1/templates/{template-name}/voiceRetrieves the content and settings of a message template for messages that are sent through the voice channel.
POST/v1/templates/{template-name}/voiceCreates a message template for messages that are sent through the voice channel.
PUT/v1/templates/{template-name}/voiceUpdates an existing message template for messages that are sent through the voice channel.
DELETE/v1/templates/{template-name}/voiceDeletes a message template for messages that were sent through the voice channel.
GET/v1/apps/{application-id}/channels/admRetrieves information about the status and settings of the ADM channel for an application.
PUT/v1/apps/{application-id}/channels/admEnables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
DELETE/v1/apps/{application-id}/channels/admDisables the ADM channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/channels/apnsRetrieves information about the status and settings of the APNs channel for an application.
PUT/v1/apps/{application-id}/channels/apnsEnables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
DELETE/v1/apps/{application-id}/channels/apnsDisables the APNs channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/channels/apns_sandboxRetrieves information about the status and settings of the APNs sandbox channel for an application.
PUT/v1/apps/{application-id}/channels/apns_sandboxEnables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
DELETE/v1/apps/{application-id}/channels/apns_sandboxDisables the APNs sandbox channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/channels/apns_voipRetrieves information about the status and settings of the APNs VoIP channel for an application.
PUT/v1/apps/{application-id}/channels/apns_voipEnables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
DELETE/v1/apps/{application-id}/channels/apns_voipDisables the APNs VoIP channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/channels/apns_voip_sandboxRetrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
PUT/v1/apps/{application-id}/channels/apns_voip_sandboxEnables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
DELETE/v1/apps/{application-id}/channels/apns_voip_sandboxDisables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}Retrieves information about an application.
DELETE/v1/apps/{application-id}Deletes an application.
GET/v1/apps/{application-id}/channels/baiduRetrieves information about the status and settings of the Baidu channel for an application.
PUT/v1/apps/{application-id}/channels/baiduEnables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
DELETE/v1/apps/{application-id}/channels/baiduDisables the Baidu channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/campaigns/{campaign-id}Retrieves information about the status, configuration, and other settings for a campaign.
PUT/v1/apps/{application-id}/campaigns/{campaign-id}Updates the configuration and other settings for a campaign.
DELETE/v1/apps/{application-id}/campaigns/{campaign-id}Deletes a campaign from an application.
GET/v1/apps/{application-id}/channels/emailRetrieves information about the status and settings of the email channel for an application.
PUT/v1/apps/{application-id}/channels/emailEnables the email channel for an application or updates the status and settings of the email channel for an application.
DELETE/v1/apps/{application-id}/channels/emailDisables the email channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/endpoints/{endpoint-id}Retrieves information about the settings and attributes of a specific endpoint for an application.
PUT/v1/apps/{application-id}/endpoints/{endpoint-id}Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to
DELETE/v1/apps/{application-id}/endpoints/{endpoint-id}Deletes an endpoint from an application.
GET/v1/apps/{application-id}/eventstreamRetrieves information about the event stream settings for an application.
POST/v1/apps/{application-id}/eventstreamCreates a new event stream for an application or updates the settings of an existing event stream for an application.
DELETE/v1/apps/{application-id}/eventstreamDeletes the event stream for an application.
GET/v1/apps/{application-id}/channels/gcmRetrieves information about the status and settings of the GCM channel for an application.
PUT/v1/apps/{application-id}/channels/gcmEnables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
DELETE/v1/apps/{application-id}/channels/gcmDisables the GCM channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/journeys/{journey-id}Retrieves information about the status, configuration, and other settings for a journey.
PUT/v1/apps/{application-id}/journeys/{journey-id}Updates the configuration and other settings for a journey.
DELETE/v1/apps/{application-id}/journeys/{journey-id}Deletes a journey from an application.
GET/v1/recommenders/{recommender-id}Retrieves information about an Amazon Pinpoint configuration for a recommender model.
PUT/v1/recommenders/{recommender-id}Updates an Amazon Pinpoint configuration for a recommender model.
DELETE/v1/recommenders/{recommender-id}Deletes an Amazon Pinpoint configuration for a recommender model.
GET/v1/apps/{application-id}/segments/{segment-id}Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
PUT/v1/apps/{application-id}/segments/{segment-id}Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an applicati
DELETE/v1/apps/{application-id}/segments/{segment-id}Deletes a segment from an application.
GET/v1/apps/{application-id}/channels/smsRetrieves information about the status and settings of the SMS channel for an application.
PUT/v1/apps/{application-id}/channels/smsEnables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
DELETE/v1/apps/{application-id}/channels/smsDisables the SMS channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/users/{user-id}Retrieves information about all the endpoints that are associated with a specific user ID.
DELETE/v1/apps/{application-id}/users/{user-id}Deletes all the endpoints that are associated with a specific user ID.
GET/v1/apps/{application-id}/channels/voiceRetrieves information about the status and settings of the voice channel for an application.
PUT/v1/apps/{application-id}/channels/voiceEnables the voice channel for an application or updates the status and settings of the voice channel for an application.
DELETE/v1/apps/{application-id}/channels/voiceDisables the voice channel for an application and deletes any existing settings for the channel.
GET/v1/apps/{application-id}/kpis/daterange/{kpi-name}Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
GET/v1/apps/{application-id}/settingsRetrieves information about the settings for an application.
PUT/v1/apps/{application-id}/settingsUpdates the settings for an application.
GET/v1/apps/{application-id}/campaigns/{campaign-id}/activitiesRetrieves information about all the activities for a campaign.
GET/v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
GET/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
GET/v1/apps/{application-id}/campaigns/{campaign-id}/versionsRetrieves information about the status, configuration, and other settings for all versions of a campaign.
GET/v1/apps/{application-id}/channelsRetrieves information about the history and status of each channel for an application.
GET/v1/apps/{application-id}/jobs/export/{job-id}Retrieves information about the status and settings of a specific export job for an application.
GET/v1/apps/{application-id}/jobs/import/{job-id}Retrieves information about the status and settings of a specific import job for an application.
GET/v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessagesRetrieves the in-app messages targeted for the provided endpoint ID.
GET/v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
GET/v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metricsRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
GET/v1/apps/{application-id}/journeys/{journey-id}/execution-metricsRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

Showing the first 100 of 119 endpoints; the full list is in the documentation.

Questions

Does the Amazon Pinpoint API need an API key?

Yes. The Amazon Pinpoint API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Pinpoint API support HTTPS?

Yes, the Amazon Pinpoint API is served over HTTPS.

How many endpoints does the Amazon Pinpoint API have?

Its OpenAPI description lists 119 endpoints in version 2016-12-01. The first 100 are shown on this page.

What are alternatives to the Amazon Pinpoint API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

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

Bearer token350 endpoints

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

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).