Amazon Pinpoint
REST API Reference

Settings

The default settings for an app in Amazon Pinpoint. You can use this resource to look up and update the settings for an app.

URI

/v1/apps/application-id/settings

HTTP Methods

GET

Used to request the settings for an app.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ApplicationSettingsResource

PUT

Used to update the settings for an app.

Body

Name Required Type

WriteApplicationSettingsRequest

true

WriteApplicationSettingsRequest

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

ApplicationSettingsResource

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 WriteApplicationSettingsRequest

{ "QuietTime": { "Start": "string", "End": "string" }, "Limits": { "Daily": 0, "Total": 0, "MessagesPerSecond": 0, "MaximumDuration": 0 }, "CampaignHook": { "LambdaFunctionName": "string", "WebUrl": "string", "Mode": "DELIVERY" } }

Response Schemas

Example ApplicationSettingsResource

{ "ApplicationId": "string", "LastModifiedDate": "string", "QuietTime": { "Start": "string", "End": "string" }, "Limits": { "Daily": 0, "Total": 0, "MessagesPerSecond": 0, "MaximumDuration": 0 }, "CampaignHook": { "LambdaFunctionName": "string", "WebUrl": "string", "Mode": "DELIVERY" } }

Example MessageBody

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

Attributes

WriteApplicationSettingsRequest

Attribute Type Description

CampaignHook

CampaignHook

Default campaign hook information.

CloudWatchMetricsEnabled

boolean

The CloudWatchMetrics settings for the app.

Limits

CampaignLimits

The limits that apply to each campaign in the project by default. Campaigns can also have their own limits, which override the settings at the project level.

QuietTime

QuietTime

The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time.

Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled.

When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable).

Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.

CampaignHook

Attribute Type Description

LambdaFunctionName

string

Lambda function name or arn to be called for delivery

Mode

string

What mode Lambda should be invoked in.

WebUrl

string

Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request

CampaignLimits

Attribute Type Description

Daily

integer

The maximum number of messages that each campaign can send to a single endpoint in a 24-hour period.

MaximumDuration

integer

The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.

MessagesPerSecond

integer

The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.

Total

integer

The maximum number of messages that an individual campaign can send to a single endpoint over the course of the campaign.

QuietTime

Attribute Type Description

End

string

The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Start

string

The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

ApplicationSettingsResource

Attribute Type Description

ApplicationId

string

The unique ID for the application.

CampaignHook

CampaignHook

Default campaign hook.

LastModifiedDate

string

The date that the settings were last updated in ISO 8601 format.

Limits

CampaignLimits

The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.

QuietTime

QuietTime

The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time.

Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled.

When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable).

Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.

MessageBody

Attribute Type Description

Message

string

The error message that's returned from the API.

RequestID

string

The unique message body ID.