Amazon Pinpoint
REST API Reference


This is the Amazon Pinpoint API Reference. It contains examples of REST resources and their operations.

Amazon Pinpoint Endpoints

Amazon Pinpoint is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of supported Regions and endpoints, see AWS Regions and Endpoints in the Amazon Web Services General Reference.

Example REST Request

The following is an example of a REST request that you make to Amazon Pinpoint:

GET /v1/apps/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/campaigns Accept: application/json Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20161127/us-east-1/mobiletargeting/aws4_request, SignedHeaders=accept;host;x-amz-date, Signature=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a1b2c3d4e5f6 Host: X-Amz-Date: 20161127T202324Z

Following this request, Amazon Pinpoint returns a response that includes the following header:

200 Access-Control-Allow-Origin: * Connection: keep-alive Content-Length: 94237 Content-Type: application/json Date: Sun, 27 Nov 2016 20:23:28 GMT X-Amz-Cf-Id: BerfOyKjyRgVGEKS2q3gHdWBZYFrqq0w4KmpamCCbY6o_xsAzxR1Iw== x-amzn-RequestId: 595c3386-b4df-11e6-855b-61b43929a1e2 X-Amzn-Trace-Id: Root=1-583b40bd-ca765532129bcbb6c5016375

Hypertext Application Language

Amazon Pinpoint provides a resource-based API that uses Hypertext Application Language (HAL). HAL provides a standard way for expressing the resources and relationships of an API as hyperlinks. Using HAL, you use HTTP methods (GET, PUT, POST, DELETE) to submit requests and receive information about the API in the response. Applications can use the information that's returned to explore the functionality of the API. For more information about HAL, see the JSON Hypertext Application Language draft.

To request a HAL response from Amazon Pinpoint, specify application/hal+json for the accept request header.