Menu
Amazon Pinpoint
REST API Reference

App

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 emails to your newsletter subscribers, or send SMS messages to your customers' phone numbers.

Use this resource to look up or delete an app.

To create an app, use the Apps resource and run a POST request against the /apps URI.

URI

/v1/apps/application-id

HTTP Methods

DELETE

Deletes an app.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ApplicationResponse

GET

Returns information about an app.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

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

Response Schemas

Example ApplicationResponse

Copy
{ "Name": "string", "Id": "string" }

Example MessageBody

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

Attributes

ApplicationResponse

Attribute Type Description

Id

string

The unique application ID.

Name

string

The display name of the application.

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.