Amazon Pinpoint
REST API Reference

Apps

An app is an Amazon Pinpoint project in which you define the audience for a distinct application, and you engage this audience with tailored messages. For example, use an app to send push notifications to your mobile app users, send email to your newsletter subscribers, or send SMS messages to your customers' phone numbers.

After you create an app, you can define your audience by registering endpoints and defining segments. To engage your audience, define campaigns or write direct messages, and send your messages by using any supported channel (mobile push, email, and SMS).

You can monitor app analytics by creating an event stream, which streams data for message deliveries and events reported by your application. Analytics are also provided in the Amazon Pinpoint console. In the console, you can open your app on the All projects page.

Use this resource to look up or create an app.

To delete an app, use the App resource and send a DELETE request to the /apps/application-id URI.

URI

/v1/apps

HTTP Methods

GET

Returns information about your apps.

Header

Name Required Type

accept

false

string

Query

Name Required Type

page-size

false

string

token

false

string

Response

Status Code Schema

200

ApplicationsResponse

POST

Creates an app.

Body

Name Required Type

CreateApplicationRequest

true

CreateApplicationRequest

Header

Name Required Type

accept

false

string

Response

Status Code Schema

201

ApplicationResponse

Errors

Errors

Status Code Schema Error Type

400

MessageBody

BadRequestException

403

MessageBody

ForbiddenException

404

MessageBody

NotFoundException

405

MessageBody

MethodNotAllowedException

429

MessageBody

TooManyRequestsException

500

MessageBody

InternalServerErrorException

Schemas

Request Schemas

Example CreateApplicationRequest

{ "Name": "string", "tags": { "string": "string" } }

Response Schemas

Example ApplicationsResponse

{ "NextToken": "string", "Item": [ { "Name": "string", "Id": "string" } ] }

Example ApplicationResponse

{ "Arn": "string", "Id": "string", "Name": "string", "tags": { "string": "string" } }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Attributes

CreateApplicationRequest

Attribute Type Description

Name

string

The display name of the application. This name appears on the Amazon Pinpoint console.

tags

object

(Optional) A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

ApplicationsResponse

Attribute Type Description

Item

array

The list of applications returned in this page.

NextToken

string

The string that you use in a subsequent request to get the next page of results in a paginated response.

ApplicationResponse

Attribute Type Description

Arn

string

The Amazon Resource Name (ARN) of the application.

Id

string

The unique ID for the application.

Name

string

The display name of the application.

tags

object

A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

MessageBody

Attribute Type Description

Message

string

The error message that's returned from the API.

RequestID

string

The unique message body ID.