Amazon Pinpoint Apps API
The Apps API from Amazon Pinpoint — 48 operation(s) for apps.
Amazon Pinpoint Apps API is one of 6 APIs that Amazon Pinpoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a getting-started guide, and rate-limit docs.
This API exposes 87 operations across 48 paths, and defines 316 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://pinpoint.{region}.amazonaws.com, https://pinpoint.{region}.amazonaws.com, http://pinpoint.{region}.amazonaws.com.cn, https://pinpoint.{region}.amazonaws.com.cn.
87 operations
48 paths
316 schemas
17 DELETE40 GET12 POST18 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Amazon Pinpoint Apps API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 87
Across 48 paths, the API surfaces 87 operations — 17 DELETE, 40 GET, 12 POST, 18 PUT. Each is listed below with its method, path, parameters, and response codes.
Apps 87
POST
/v1/apps
Amazon Pinpoint Create App
GET
/v1/apps
Amazon Pinpoint Get Apps
POST
/v1/apps/{application-id}/campaigns
Amazon Pinpoint Create Campaign
GET
/v1/apps/{application-id}/campaigns
Amazon Pinpoint Get Campaigns
POST
/v1/apps/{application-id}/jobs/export
Amazon Pinpoint Create Export Job
GET
/v1/apps/{application-id}/jobs/export
Amazon Pinpoint Get Export Jobs
POST
/v1/apps/{application-id}/jobs/import
Amazon Pinpoint Create Import Job
GET
/v1/apps/{application-id}/jobs/import
Amazon Pinpoint Get Import Jobs
POST
/v1/apps/{application-id}/journeys
Amazon Pinpoint Create Journey
GET
/v1/apps/{application-id}/journeys
Amazon Pinpoint List Journeys
POST
/v1/apps/{application-id}/segments
Amazon Pinpoint Create Segment
GET
/v1/apps/{application-id}/segments
Amazon Pinpoint Get Segments
DELETE
/v1/apps/{application-id}/channels/adm
Amazon Pinpoint Delete Adm Channel
GET
/v1/apps/{application-id}/channels/adm
Amazon Pinpoint Get Adm Channel
PUT
/v1/apps/{application-id}/channels/adm
Amazon Pinpoint Update Adm Channel
DELETE
/v1/apps/{application-id}/channels/apns
Amazon Pinpoint Delete Apns Channel
GET
/v1/apps/{application-id}/channels/apns
Amazon Pinpoint Get Apns Channel
PUT
/v1/apps/{application-id}/channels/apns
Amazon Pinpoint Update Apns Channel
DELETE
/v1/apps/{application-id}/channels/apns_sandbox
Amazon Pinpoint Delete Apns Sandbox Channel
GET
/v1/apps/{application-id}/channels/apns_sandbox
Amazon Pinpoint Get Apns Sandbox Channel
PUT
/v1/apps/{application-id}/channels/apns_sandbox
Amazon Pinpoint Update Apns Sandbox Channel
DELETE
/v1/apps/{application-id}/channels/apns_voip
Amazon Pinpoint Delete Apns Voip Channel
GET
/v1/apps/{application-id}/channels/apns_voip
Amazon Pinpoint Get Apns Voip Channel
PUT
/v1/apps/{application-id}/channels/apns_voip
Amazon Pinpoint Update Apns Voip Channel
DELETE
/v1/apps/{application-id}/channels/apns_voip_sandbox
Amazon Pinpoint Delete Apns Voip Sandbox Channel
GET
/v1/apps/{application-id}/channels/apns_voip_sandbox
Amazon Pinpoint Get Apns Voip Sandbox Channel
PUT
/v1/apps/{application-id}/channels/apns_voip_sandbox
Amazon Pinpoint Update Apns Voip Sandbox Channel
DELETE
/v1/apps/{application-id}
Amazon Pinpoint Delete App
GET
/v1/apps/{application-id}
Amazon Pinpoint Get App
DELETE
/v1/apps/{application-id}/channels/baidu
Amazon Pinpoint Delete Baidu Channel
GET
/v1/apps/{application-id}/channels/baidu
Amazon Pinpoint Get Baidu Channel
PUT
/v1/apps/{application-id}/channels/baidu
Amazon Pinpoint Update Baidu Channel
DELETE
/v1/apps/{application-id}/campaigns/{campaign-id}
Amazon Pinpoint Delete Campaign
GET
/v1/apps/{application-id}/campaigns/{campaign-id}
Amazon Pinpoint Get Campaign
PUT
/v1/apps/{application-id}/campaigns/{campaign-id}
Amazon Pinpoint Update Campaign
DELETE
/v1/apps/{application-id}/channels/email
Amazon Pinpoint Delete Email Channel
GET
/v1/apps/{application-id}/channels/email
Amazon Pinpoint Get Email Channel
PUT
/v1/apps/{application-id}/channels/email
Amazon Pinpoint Update Email Channel
DELETE
/v1/apps/{application-id}/endpoints/{endpoint-id}
Amazon Pinpoint Delete Endpoint
GET
/v1/apps/{application-id}/endpoints/{endpoint-id}
Amazon Pinpoint Get Endpoint
PUT
/v1/apps/{application-id}/endpoints/{endpoint-id}
Amazon Pinpoint Update Endpoint
DELETE
/v1/apps/{application-id}/eventstream
Amazon Pinpoint Delete Event Stream
GET
/v1/apps/{application-id}/eventstream
Amazon Pinpoint Get Event Stream
POST
/v1/apps/{application-id}/eventstream
Amazon Pinpoint Put Event Stream
DELETE
/v1/apps/{application-id}/channels/gcm
Amazon Pinpoint Delete Gcm Channel
GET
/v1/apps/{application-id}/channels/gcm
Amazon Pinpoint Get Gcm Channel
PUT
/v1/apps/{application-id}/channels/gcm
Amazon Pinpoint Update Gcm Channel
DELETE
/v1/apps/{application-id}/journeys/{journey-id}
Amazon Pinpoint Delete Journey
GET
/v1/apps/{application-id}/journeys/{journey-id}
Amazon Pinpoint Get Journey
PUT
/v1/apps/{application-id}/journeys/{journey-id}
Amazon Pinpoint Update Journey
DELETE
/v1/apps/{application-id}/segments/{segment-id}
Amazon Pinpoint Delete Segment
GET
/v1/apps/{application-id}/segments/{segment-id}
Amazon Pinpoint Get Segment
PUT
/v1/apps/{application-id}/segments/{segment-id}
Amazon Pinpoint Update Segment
DELETE
/v1/apps/{application-id}/channels/sms
Amazon Pinpoint Delete Sms Channel
GET
/v1/apps/{application-id}/channels/sms
Amazon Pinpoint Get Sms Channel
PUT
/v1/apps/{application-id}/channels/sms
Amazon Pinpoint Update Sms Channel
DELETE
/v1/apps/{application-id}/users/{user-id}
Amazon Pinpoint Delete User Endpoints
GET
/v1/apps/{application-id}/users/{user-id}
Amazon Pinpoint Get User Endpoints
DELETE
/v1/apps/{application-id}/channels/voice
Amazon Pinpoint Delete Voice Channel
GET
/v1/apps/{application-id}/channels/voice
Amazon Pinpoint Get Voice Channel
PUT
/v1/apps/{application-id}/channels/voice
Amazon Pinpoint Update Voice Channel
GET
/v1/apps/{application-id}/kpis/daterange/{kpi-name}
Amazon Pinpoint Get Application Date Range Kpi
GET
/v1/apps/{application-id}/settings
Amazon Pinpoint Get Application Settings
PUT
/v1/apps/{application-id}/settings
Amazon Pinpoint Update Application Settings
GET
/v1/apps/{application-id}/campaigns/{campaign-id}/activities
Amazon Pinpoint Get Campaign Activities
GET
/v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}
Amazon Pinpoint Get Campaign Date Range Kpi
GET
/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}
Amazon Pinpoint Get Campaign Version
GET
/v1/apps/{application-id}/campaigns/{campaign-id}/versions
Amazon Pinpoint Get Campaign Versions
GET
/v1/apps/{application-id}/channels
Amazon Pinpoint Get Channels
GET
/v1/apps/{application-id}/jobs/export/{job-id}
Amazon Pinpoint Get Export Job
GET
/v1/apps/{application-id}/jobs/import/{job-id}
Amazon Pinpoint Get Import Job
GET
/v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages
Amazon Pinpoint Get in App Messages
GET
/v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}
Amazon Pinpoint Get Journey Date Range Kpi
GET
/v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics
Amazon Pinpoint Get Journey Execution Activity Metrics
GET
/v1/apps/{application-id}/journeys/{journey-id}/execution-metrics
Amazon Pinpoint Get Journey Execution Metrics
GET
/v1/apps/{application-id}/segments/{segment-id}/jobs/export
Amazon Pinpoint Get Segment Export Jobs
GET
/v1/apps/{application-id}/segments/{segment-id}/jobs/import
Amazon Pinpoint Get Segment Import Jobs
GET
/v1/apps/{application-id}/segments/{segment-id}/versions/{version}
Amazon Pinpoint Get Segment Version
GET
/v1/apps/{application-id}/segments/{segment-id}/versions
Amazon Pinpoint Get Segment Versions
POST
/v1/apps/{application-id}/events
Amazon Pinpoint Put Events
PUT
/v1/apps/{application-id}/attributes/{attribute-type}
Amazon Pinpoint Remove Attributes
POST
/v1/apps/{application-id}/messages
Amazon Pinpoint Send Messages
POST
/v1/apps/{application-id}/otp
Amazon Pinpoint Send O T P Message
POST
/v1/apps/{application-id}/users-messages
Amazon Pinpoint Send Users Messages
PUT
/v1/apps/{application-id}/endpoints
Amazon Pinpoint Update Endpoints Batch
PUT
/v1/apps/{application-id}/journeys/{journey-id}/state
Amazon Pinpoint Update Journey State
POST
/v1/apps/{application-id}/verify-otp
Amazon Pinpoint Verify O T P Message
Schemas 316
The contract defines 316 schemas that model the data the API accepts and returns. The most detailed are CampaignResponse (25 properties), JourneyResponse (21 properties), APNSMessage (18 properties), GCMMessage (17 properties). Each schema is shown below with its type and property counts.
EndpointUser
object
Specifies data for one or more attributes that describe the user who's associated with an endpoint.
2 properties
JourneySchedule
object
Specifies the schedule settings for a journey.
3 properties
MapOfChannelResponse
object
Type
string
GetSegmentVersionResponse
object
1 property
1 required
DeleteAdmChannelResponse
object
1 property
1 required
PutEventsResponse
object
1 property
1 required
EventItemResponse
object
Provides the status code and message that result from processing an event.
2 properties
ButtonAction
string
EndpointResponse
object
Provides information about the channel type and other settings for an endpoint.
15 properties
DeleteSegmentResponse
object
1 property
1 required
DeliveryStatus
string
BadRequestException
SegmentCondition
object
Specifies a segment to associate with an activity in a journey.
1 property
1 required
GetUserEndpointsResponse
object
1 property
1 required
OpenHours
object
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
5 properties
CampaignSmsMessage
object
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
6 properties
UpdateBaiduChannelResponse
object
1 property
1 required
DefaultButtonConfiguration
object
Default button configuration.
6 properties
2 required
ClosedDays
object
The time when journey will stop sending messages.
5 properties
ListOfTreatmentResource
array
Session
object
Provides information about a session.
4 properties
2 required
TemplateConfiguration
object
Specifies the message template to use for the message, for each type of channel.
4 properties
MapOfListOf__string
object
BaiduMessage
object
Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.
14 properties
GetChannelsResponse
object
1 property
1 required
CampaignStatus
string
ApplicationDateRangeKpiResponse
object
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
6 properties
5 required
EndpointSendConfiguration
object
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
5 properties
ListOf__EndpointTypesElement
array
SMSMessageActivity
object
Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.
4 properties
ImportJobResource
object
Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simpl…
8 properties
3 required
UpdateApnsSandboxChannelResponse
object
1 property
1 required
UpdateCampaignResponse
object
1 property
1 required
GPSCoordinates
object
Specifies the GPS coordinates of a location.
2 properties
2 required
RandomSplitEntry
object
Specifies the settings for a path in a random split activity in a journey.
2 properties
ListOfRandomSplitEntry
array
UpdateEndpointsBatchResponse
object
1 property
1 required
StartCondition
object
Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.
3 properties
WaitActivity
object
Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before movi…
2 properties
ListOfCampaignResponse
array
SegmentGroupList
object
Specifies the settings that define the relationships between segment groups for a segment.
2 properties
GetExportJobResponse
object
1 property
1 required
GetJourneyResponse
object
1 property
1 required
JourneyExecutionMetricsResponse
object
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.
4 properties
4 required
JourneyLimits
object
Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.
4 properties
VoiceMessage
object
Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
5 properties
ListOfEndpointBatchItem
array
JourneysResponse
object
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
2 properties
1 required
ClosedDaysRule
object
Closed Days Rule. Part of Journey sending schedule.
3 properties
__double
number
DeleteAppResponse
object
1 property
1 required
EventStream
object
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
6 properties
3 required
MapOfEventItemResponse
object
ConflictException
InAppMessageBodyConfig
object
Text config for Message Body.
3 properties
3 required
MapOfEvent
object
WriteTreatmentResource
object
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
7 properties
1 required
MessageType
string
InAppMessagesResponse
object
Get in-app messages response object.
1 property
RawEmail
object
Specifies the contents of an email message, represented as a raw MIME message.
1 property
Event
object
Specifies information about an event that reports data to Amazon Pinpoint.
10 properties
2 required
SMSChannelResponse
object
Provides information about the status and settings of the SMS channel for an application.
14 properties
1 required
CampaignInAppMessage
object
In-app message configuration.
4 properties
ChannelType
string
CustomMessageActivity
object
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
6 properties
ListOf__string
array
GetCampaignVersionsResponse
object
1 property
1 required
SetDimension
object
Specifies the dimension type and values for a segment dimension.
2 properties
1 required
GetApnsVoipChannelResponse
object
1 property
1 required
ListOfImportJobResponse
array
Template
object
Specifies the name and version of the message template to use for the message.
2 properties
EndpointsResponse
object
Provides information about all the endpoints that are associated with a user ID.
1 property
1 required
OpenHoursRule
object
List of OpenHours Rules.
2 properties
SendMessagesResponse
object
1 property
1 required
EmailMessageActivity
object
Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.
4 properties
Condition
object
Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.
2 properties
TooManyRequestsException
CampaignCustomMessage
object
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
1 property
ListOfOpenHoursRules
array
GetCampaignActivitiesResponse
object
1 property
1 required
GetEndpointResponse
object
1 property
1 required
DeleteApnsChannelResponse
object
1 property
1 required
InternalServerErrorException
InAppMessageCampaign
object
Targeted in-app message campaign.
8 properties
MapOf__double
object
CreateImportJobResponse
object
1 property
1 required
MessageResponse
object
Provides information about the results of a request to send a message to an endpoint address.
4 properties
1 required
SegmentDimensions
object
Specifies the dimension settings for a segment.
6 properties
CampaignDateRangeKpiResponse
object
Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.
7 properties
6 required
DeleteUserEndpointsResponse
object
1 property
1 required
GetJourneyExecutionActivityMetricsResponse
object
1 property
1 required
UpdateJourneyResponse
object
1 property
1 required
TreatmentResource
object
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
9 properties
2 required
GetEventStreamResponse
object
1 property
1 required
DeleteApnsVoipChannelResponse
object
1 property
1 required
JourneyPushMessage
object
Specifies the message configuration for a push notification that's sent to participants in a journey.
1 property
ListOfActivityResponse
array
Schedule
object
Specifies the schedule settings for a campaign.
7 properties
1 required
ListOfEndpointResponse
array
GetVoiceChannelResponse
object
1 property
1 required
GetSegmentImportJobsResponse
object
1 property
1 required
JourneyExecutionActivityMetricsResponse
object
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that…
6 properties
6 required
InAppMessageButton
object
Button Config for an in-app message.
4 properties
DeleteBaiduChannelResponse
object
1 property
1 required
MetricDimension
object
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
2 properties
2 required
BaiduChannelResponse
object
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
11 properties
2 required
GetApnsChannelResponse
object
1 property
1 required
EventStartCondition
object
Specifies the settings for an event that causes a journey activity to start.
2 properties
SimpleEmail
object
Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.
3 properties
MessageBody
object
Provides information about an API request or response.
2 properties
EndpointMessageResult
object
Provides information about the delivery status and results of sending a message directly to an endpoint.
6 properties
2 required
QuietTime
object
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
2 properties
GPSPointDimension
object
Specifies GPS-based criteria for including or excluding endpoints from a segment.
2 properties
1 required
__integer
integer
SendOTPMessageResponse
object
1 property
1 required
Include
string
EmailChannelResponse
object
Provides information about the status and settings of the email channel for an application.
15 properties
1 required
GetApplicationDateRangeKpiResponse
object
1 property
1 required
GetApnsVoipSandboxChannelResponse
object
1 property
1 required
BaseKpiResult
object
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
1 property
1 required
ADMMessage
object
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
16 properties
VoiceChannelResponse
object
Provides information about the status and settings of the voice channel for an application.
10 properties
1 required
UpdateApplicationSettingsResponse
object
1 property
1 required
ListOfMultiConditionalBranch
array
EndpointItemResponse
object
Provides the status code and message that result from processing data for an endpoint.
2 properties
PushMessageActivity
object
Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.
4 properties
CreateExportJobResponse
object
1 property
1 required
CampaignLimits
object
For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in th…
5 properties
Mode
string
ListOfResultRow
array
MapOf__integer
object
GCMChannelResponse
object
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications th…
11 properties
2 required
Action
string
GetCampaignVersionResponse
object
1 property
1 required
GetEmailChannelResponse
object
1 property
1 required
GetSmsChannelResponse
object
1 property
1 required
GetCampaignsResponse
object
1 property
1 required
EventDimensions
object
Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
3 properties
Duration
string
CampaignsResponse
object
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
2 properties
1 required
Format
string
MultiConditionalSplitActivity
object
Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a…
3 properties
InAppMessageContent
object
The configuration for the message content.
6 properties
SegmentLocation
object
Specifies geographical dimension settings for a segment.
2 properties
ListOfResultRowValue
array
DeleteEndpointResponse
object
1 property
1 required
GetAppResponse
object
1 property
1 required
ChannelResponse
object
Provides information about the general settings and status of a channel for an application.
9 properties
ChannelsResponse
object
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
1 property
1 required
EndpointLocation
object
Specifies geographic information about an endpoint.
6 properties
UpdateJourneyStateResponse
object
1 property
1 required
CampaignEmailMessage
object
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
4 properties
APNSMessage
object
Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.
18 properties
RecencyDimension
object
Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.
2 properties
2 required
PayloadTooLargeException
CreateCampaignResponse
object
1 property
1 required
EmailMessage
object
Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.
7 properties
DeleteEmailChannelResponse
object
1 property
1 required
CustomDeliveryConfiguration
object
Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the Cam…
2 properties
1 required
GetJourneyExecutionMetricsResponse
object
1 property
1 required
EndpointBatchItem
object
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
12 properties
APNSVoipSandboxChannelResponse
object
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
12 properties
1 required
Activity
object
Specifies the configuration and other settings for an activity in a journey.
11 properties
EventsBatch
object
Specifies a batch of endpoints and events to process.
2 properties
2 required
ListOfWriteTreatmentResource
array
DefaultMessage
object
Specifies the default message for all channels.
2 properties
__boolean
boolean
ExportJobsResponse
object
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to…
2 properties
1 required
MapOfMapOfEndpointMessageResult
object
ListOfApplicationResponse
array
ListOfJourneyResponse
array
DimensionType
string
UpdateApnsChannelResponse
object
1 property
1 required
AttributeDimension
object
Specifies attribute-based criteria for including or excluding endpoints from a segment.
2 properties
1 required
GetSegmentVersionsResponse
object
1 property
1 required
GetJourneyDateRangeKpiResponse
object
1 property
1 required
Operator
string
APNSSandboxChannelResponse
object
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
12 properties
1 required
AddressConfiguration
object
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
6 properties
ListOfSegmentDimensions
array
CampaignHook
object
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
3 properties
JourneyEmailMessage
object
Specifies the "From" address for an email message that's sent to participants in a journey.
1 property
WaitTime
object
Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves part…
2 properties
ApplicationsResponse
object
Provides information about all of your applications.
2 properties
EventsResponse
object
Provides information about endpoints and the events that they're associated with.
1 property
RecencyType
string
UpdateSmsChannelResponse
object
1 property
1 required
CreateSegmentResponse
object
1 property
1 required
GetCampaignResponse
object
1 property
1 required
GetImportJobsResponse
object
1 property
1 required
UpdateAdmChannelResponse
object
1 property
1 required
Layout
string
UpdateGcmChannelResponse
object
1 property
1 required
FilterType
string
RandomSplitActivity
object
Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many…
1 property
VerificationResponse
object
Verify OTP Message Response.
1 property
ItemResponse
object
Provides information about the results of a request to create or update an endpoint that's associated with an event.
2 properties
SegmentReference
object
Specifies the segment identifier and version of a segment.
2 properties
1 required
MethodNotAllowedException
ForbiddenException
GCMMessage
object
Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send mess…
17 properties
ApplicationSettingsResource
object
Provides information about an application, including the default settings for an application.
5 properties
1 required
UpdateEmailChannelResponse
object
1 property
1 required
__string
string
MapOfEndpointSendConfiguration
object
GetSegmentResponse
object
1 property
1 required
ListOfSimpleCondition
array
State
string
MapOfMessageResult
object
SendUsersMessageResponse
object
Provides information about which users and endpoints a message was sent to.
3 properties
1 required
JourneyCustomMessage
object
Specifies the message content for a custom channel message that's sent to participants in a journey.
1 property
EventFilter
object
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
2 properties
2 required
PutEventStreamResponse
object
1 property
1 required
ActivitiesResponse
object
Provides information about the activities that were performed by a campaign.
2 properties
1 required
JourneyChannelSettings
object
The channel-specific configurations for the journey.
2 properties
VerifyOTPMessageResponse
object
1 property
1 required
DeleteVoiceChannelResponse
object
1 property
1 required
MapOfAttributeDimension
object
MessageConfiguration
object
Specifies the message configuration settings for a campaign.
9 properties
MapOfAddressConfiguration
object
SimpleEmailPart
object
Specifies the subject or body of an email message, represented as textual email data and the applicable character set.
2 properties
ImportJobResponse
object
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simp…
13 properties
6 required
MapOfEventsBatch
object
MultiConditionalBranch
object
Specifies a condition to evaluate for an activity path in a journey.
2 properties
Alignment
string
DeleteEventStreamResponse
object
1 property
1 required
CampaignEventFilter
object
Specifies the settings for events that cause a campaign to be sent.
2 properties
2 required
__EndpointTypesElement
string
ListOfExportJobResponse
array
MessageResult
object
Provides information about the results of sending a message directly to an endpoint address.
5 properties
2 required
GetSegmentsResponse
object
1 property
1 required
RemoveAttributesResponse
object
1 property
1 required
UpdateApnsVoipSandboxChannelResponse
object
1 property
1 required
GetGcmChannelResponse
object
1 property
1 required
__blob
string
AttributesResource
object
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
3 properties
2 required
UpdateApnsVoipChannelResponse
object
1 property
1 required
SegmentBehaviors
object
Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.
1 property
CampaignState
object
Provides information about the status of a campaign.
1 property
DeleteApnsSandboxChannelResponse
object
1 property
1 required
InAppMessageHeaderConfig
object
Text config for Message Header.
3 properties
3 required
SegmentType
string
GetAdmChannelResponse
object
1 property
1 required
HoldoutActivity
object
Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.
2 properties
1 required
InAppCampaignSchedule
object
Schedule of the campaign.
3 properties
DeleteCampaignResponse
object
1 property
1 required
SegmentDemographics
object
Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devi…
6 properties
GetApnsSandboxChannelResponse
object
1 property
1 required
__timestampIso8601
string
NotFoundException
ListOfClosedDaysRules
array
JourneyDateRangeKpiResponse
object
Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.
7 properties
6 required
GetCampaignDateRangeKpiResponse
object
1 property
1 required
CampaignResponse
object
Provides information about the status, configuration, and other settings for a campaign.
25 properties
7 required
EndpointDemographic
object
Specifies demographic information about an endpoint, such as the applicable time zone and platform.
8 properties
ADMChannelResponse
object
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
10 properties
1 required
Frequency
string
JourneyResponse
object
Provides information about the status, configuration, and other settings for a journey.
21 properties
3 required
Message
object
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
12 properties
GetAppsResponse
object
1 property
1 required
MapOfItemResponse
object
CreateAppResponse
object
1 property
1 required
InAppMessage
object
Provides all fields required for building an in-app message.
3 properties
SendUsersMessagesResponse
object
1 property
1 required
ListOfInAppMessageContent
array
ListOfSegmentReference
array
JourneySMSMessage
object
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
5 properties
GetBaiduChannelResponse
object
1 property
1 required
DeleteSmsChannelResponse
object
1 property
1 required
SourceType
string
SegmentImportResource
object
Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.
6 properties
5 required
SimpleCondition
object
Specifies a condition to evaluate for an activity in a journey.
3 properties
GetInAppMessagesResponse
object
1 property
1 required
ImportJobsResponse
object
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that impor…
2 properties
1 required
DefaultPushNotificationMessage
object
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
7 properties
OverrideButtonConfiguration
object
Override button configuration.
2 properties
1 required
CreateJourneyResponse
object
1 property
1 required
AttributeType
string
EventCondition
object
Specifies the conditions to evaluate for an event that applies to an activity in a journey.
2 properties
SegmentResponse
object
Provides information about the configuration, dimension, and other settings for a segment.
12 properties
5 required
MapOfActivity
object
ExportJobResponse
object
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Sto…
13 properties
6 required
APNSVoipChannelResponse
object
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
12 properties
1 required
SegmentGroup
object
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
4 properties
ListOfInAppMessageCampaign
array
ConditionalSplitActivity
object
Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditio…
4 properties
GetSegmentExportJobsResponse
object
1 property
1 required
ResultRowValue
object
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or j…
3 properties
3 required
UpdateVoiceChannelResponse
object
1 property
1 required
PublicEndpoint
object
Specifies the properties and attributes of an endpoint that's associated with an event.
11 properties
GetExportJobsResponse
object
1 property
1 required
MapOfListOfOpenHoursRules
object
ListJourneysResponse
object
1 property
1 required
DeleteGcmChannelResponse
object
1 property
1 required
ListOfSegmentGroup
array
SegmentsResponse
object
Provides information about all the segments that are associated with an application.
2 properties
1 required
ActivityResponse
object
Provides information about an activity that was performed by a campaign.
13 properties
3 required
DeleteApnsVoipSandboxChannelResponse
object
1 property
1 required
JobStatus
string
GetApplicationSettingsResponse
object
1 property
1 required
ListOfSegmentResponse
array
SMSMessage
object
Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.
9 properties
MapOfEndpointMessageResult
object
ContactCenterActivity
object
1 property
DirectMessageConfiguration
object
Specifies the settings and content for the default message and any default messages that you tailored for specific channels.
9 properties
MapOfMetricDimension
object
DeleteJourneyResponse
object
1 property
1 required
APNSChannelResponse
object
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
12 properties
1 required
ExportJobResource
object
Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Stor…
4 properties
2 required
UpdateEndpointResponse
object
1 property
1 required
ResultRow
object
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
2 properties
2 required
MapOf__string
object
GetImportJobResponse
object
1 property
1 required
ApplicationResponse
object
Provides information about an application.
5 properties
3 required
UpdateSegmentResponse
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Amazon Pinpoint 5
Other APIs Amazon Pinpoint publishes across the network.
Amazon Pinpoint Applications API
Amazon Pinpoint Phone API
Amazon Pinpoint Recommenders API
Amazon Pinpoint Tags API
Amazon Pinpoint Templates API
#Application
Where this information came from
This is an independent, third-party profile of Amazon Pinpoint Apps API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.