Menu
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

Copy
{ "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

Copy
{ "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

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

Attributes

WriteApplicationSettingsRequest

Attribute Type Description

CampaignHook

CampaignHook

Default campaign hook information.

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. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.

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 the campaign can send daily.

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 total number of messages that the campaign can send.

QuietTime

Attribute Type Description

End

string

The default end time for quiet time in ISO 8601 format.

Start

string

The default start time for quiet time in ISO 8601 format.

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. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.