Amazon Web Services, Inc.

Amazon Pinpoint

Doc Engage API - Amazon Pinpoint API

Communication#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Doc Engage API - Amazon Pinpoint API

Endpoints 122

  • GETGet apps/v1/apps?page-size=string&token=stringRetrieves information about all the applications that are associated with your Amazon Pinpoint account.
  • POSTCreate app/v1/appsCreates an application.
  • GETGet campaigns/v1/apps/:ApplicationId/campaigns?page-size=string&token=stringRetrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
  • POSTCreate campaign/v1/apps/:ApplicationId/campaignsCreates a new campaign for an application or updates the settings of an existing campaign for an application.
  • GETGet email template/v1/templates/:TemplateName/email?version=stringRetrieves the content and settings of a message template for messages that are sent through the email channel.
  • PUTUpdate email template/v1/templates/:TemplateName/email?create-new-version=trueUpdates an existing message template for messages that are sent through the email channel.
  • POSTCreate email template/v1/templates/:TemplateName/emailCreates a message template for messages that are sent through the email channel.
  • DELETEDelete email template/v1/templates/:TemplateName/email?version=stringDeletes a message template for messages that were sent through the email channel.
  • GETGet export jobs/v1/apps/:ApplicationId/jobs/export?page-size=string&token=stringRetrieves information about the status and settings of all the export jobs for an application.
  • POSTCreate export job/v1/apps/:ApplicationId/jobs/exportCreates an export job for an application.
  • GETGet import jobs/v1/apps/:ApplicationId/jobs/import?page-size=string&token=stringRetrieves information about the status and settings of all the import jobs for an application.
  • POSTCreate import job/v1/apps/:ApplicationId/jobs/importCreates an import job for an application.
  • GETGet in app template/v1/templates/:TemplateName/inapp?version=stringRetrieves the content and settings of a message template for messages sent through the in-app channel.
  • PUTUpdate in app template/v1/templates/:TemplateName/inapp?create-new-version=trueUpdates an existing message template for messages sent through the in-app message channel.
  • POSTCreate in app template/v1/templates/:TemplateName/inappCreates a new message template for messages using the in-app message channel.
  • DELETEDelete in app template/v1/templates/:TemplateName/inapp?version=stringDeletes a message template for messages sent using the in-app message channel.
  • GETList journeys/v1/apps/:ApplicationId/journeys?page-size=string&token=stringRetrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
  • POSTCreate journey/v1/apps/:ApplicationId/journeysCreates a journey for an application.
  • GETGet push template/v1/templates/:TemplateName/push?version=stringRetrieves the content and settings of a message template for messages that are sent through a push notification channel.
  • PUTUpdate push template/v1/templates/:TemplateName/push?create-new-version=trueUpdates an existing message template for messages that are sent through a push notification channel.
  • POSTCreate push template/v1/templates/:TemplateName/pushCreates a message template for messages that are sent through a push notification channel.
  • DELETEDelete push template/v1/templates/:TemplateName/push?version=stringDeletes a message template for messages that were sent through a push notification channel.
  • GETGet recommender configurations/v1/recommenders?page-size=string&token=stringRetrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
  • POSTCreate recommender configuration/v1/recommendersCreates an Amazon Pinpoint configuration for a recommender model.
  • GETGet segments/v1/apps/:ApplicationId/segments?page-size=string&token=stringRetrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
  • POSTCreate segment/v1/apps/:ApplicationId/segmentsCreates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an…
  • GETGet sms template/v1/templates/:TemplateName/sms?version=stringRetrieves the content and settings of a message template for messages that are sent through the SMS channel.
  • PUTUpdate sms template/v1/templates/:TemplateName/sms?create-new-version=trueUpdates an existing message template for messages that are sent through the SMS channel.
  • POSTCreate sms template/v1/templates/:TemplateName/smsCreates a message template for messages that are sent through the SMS channel.
  • DELETEDelete sms template/v1/templates/:TemplateName/sms?version=stringDeletes a message template for messages that were sent through the SMS channel.
  • GETGet voice template/v1/templates/:TemplateName/voice?version=stringRetrieves the content and settings of a message template for messages that are sent through the voice channel.
  • PUTUpdate voice template/v1/templates/:TemplateName/voice?create-new-version=true&version=stringUpdates an existing message template for messages that are sent through the voice channel.
  • POSTCreate voice template/v1/templates/:TemplateName/voiceCreates a message template for messages that are sent through the voice channel.
  • DELETEDelete voice template/v1/templates/:TemplateName/voice?version=stringDeletes a message template for messages that were sent through the voice channel.
  • GETGet adm channel/v1/apps/:ApplicationId/channels/admRetrieves information about the status and settings of the ADM channel for an application.
  • PUTUpdate adm channel/v1/apps/:ApplicationId/channels/admEnables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
  • DELETEDelete adm channel/v1/apps/:ApplicationId/channels/admDisables the ADM channel for an application and deletes any existing settings for the channel.
  • GETGet apns channel/v1/apps/:ApplicationId/channels/apnsRetrieves information about the status and settings of the APNs channel for an application.
  • PUTUpdate apns channel/v1/apps/:ApplicationId/channels/apnsEnables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
  • DELETEDelete apns channel/v1/apps/:ApplicationId/channels/apnsDisables the APNs channel for an application and deletes any existing settings for the channel.
  • GETGet apns sandbox channel/v1/apps/:ApplicationId/channels/apns_sandboxRetrieves information about the status and settings of the APNs sandbox channel for an application.
  • PUTUpdate apns sandbox channel/v1/apps/:ApplicationId/channels/apns_sandboxEnables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
  • DELETEDelete apns sandbox channel/v1/apps/:ApplicationId/channels/apns_sandboxDisables the APNs sandbox channel for an application and deletes any existing settings for the channel.
  • GETGet apns voip channel/v1/apps/:ApplicationId/channels/apns_voipRetrieves information about the status and settings of the APNs VoIP channel for an application.
  • PUTUpdate apns voip channel/v1/apps/:ApplicationId/channels/apns_voipEnables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
  • DELETEDelete apns voip channel/v1/apps/:ApplicationId/channels/apns_voipDisables the APNs VoIP channel for an application and deletes any existing settings for the channel.
  • GETGet apns voip sandbox channel/v1/apps/:ApplicationId/channels/apns_voip_sandboxRetrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
  • PUTUpdate apns voip sandbox channel/v1/apps/:ApplicationId/channels/apns_voip_sandboxEnables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
  • DELETEDelete apns voip sandbox channel/v1/apps/:ApplicationId/channels/apns_voip_sandboxDisables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
  • GETGet app/v1/apps/:ApplicationIdRetrieves information about an application.
  • DELETEDelete app/v1/apps/:ApplicationIdDeletes an application.
  • GETGet baidu channel/v1/apps/:ApplicationId/channels/baiduRetrieves information about the status and settings of the Baidu channel for an application.
  • PUTUpdate baidu channel/v1/apps/:ApplicationId/channels/baiduEnables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
  • DELETEDelete baidu channel/v1/apps/:ApplicationId/channels/baiduDisables the Baidu channel for an application and deletes any existing settings for the channel.
  • GETGet campaign/v1/apps/:ApplicationId/campaigns/:CampaignIdRetrieves information about the status, configuration, and other settings for a campaign.
  • PUTUpdate campaign/v1/apps/:ApplicationId/campaigns/:CampaignIdUpdates the configuration and other settings for a campaign.
  • DELETEDelete campaign/v1/apps/:ApplicationId/campaigns/:CampaignIdDeletes a campaign from an application.
  • GETGet email channel/v1/apps/:ApplicationId/channels/emailRetrieves information about the status and settings of the email channel for an application.
  • PUTUpdate email channel/v1/apps/:ApplicationId/channels/emailEnables the email channel for an application or updates the status and settings of the email channel for an application.
  • DELETEDelete email channel/v1/apps/:ApplicationId/channels/emailDisables the email channel for an application and deletes any existing settings for the channel.
  • GETGet endpoint/v1/apps/:ApplicationId/endpoints/:EndpointIdRetrieves information about the settings and attributes of a specific endpoint for an application.
  • PUTUpdate endpoint/v1/apps/:ApplicationId/endpoints/:EndpointIdCreates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation…
  • DELETEDelete endpoint/v1/apps/:ApplicationId/endpoints/:EndpointIdDeletes an endpoint from an application.
  • GETGet event stream/v1/apps/:ApplicationId/eventstreamRetrieves information about the event stream settings for an application.
  • POSTPut event stream/v1/apps/:ApplicationId/eventstreamCreates a new event stream for an application or updates the settings of an existing event stream for an application.
  • DELETEDelete event stream/v1/apps/:ApplicationId/eventstreamDeletes the event stream for an application.
  • GETGet gcm channel/v1/apps/:ApplicationId/channels/gcmRetrieves information about the status and settings of the GCM channel for an application.
  • PUTUpdate gcm channel/v1/apps/:ApplicationId/channels/gcmEnables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
  • DELETEDelete gcm channel/v1/apps/:ApplicationId/channels/gcmDisables the GCM channel for an application and deletes any existing settings for the channel.
  • GETGet journey/v1/apps/:ApplicationId/journeys/:JourneyIdRetrieves information about the status, configuration, and other settings for a journey.
  • PUTUpdate journey/v1/apps/:ApplicationId/journeys/:JourneyIdUpdates the configuration and other settings for a journey.
  • DELETEDelete journey/v1/apps/:ApplicationId/journeys/:JourneyIdDeletes a journey from an application.
  • GETGet recommender configuration/v1/recommenders/:RecommenderIdRetrieves information about an Amazon Pinpoint configuration for a recommender model.
  • PUTUpdate recommender configuration/v1/recommenders/:RecommenderIdUpdates an Amazon Pinpoint configuration for a recommender model.
  • DELETEDelete recommender configuration/v1/recommenders/:RecommenderIdDeletes an Amazon Pinpoint configuration for a recommender model.
  • GETGet segment/v1/apps/:ApplicationId/segments/:SegmentIdRetrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
  • PUTUpdate segment/v1/apps/:ApplicationId/segments/:SegmentIdCreates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an…
  • DELETEDelete segment/v1/apps/:ApplicationId/segments/:SegmentIdDeletes a segment from an application.
  • GETGet sms channel/v1/apps/:ApplicationId/channels/smsRetrieves information about the status and settings of the SMS channel for an application.
  • PUTUpdate sms channel/v1/apps/:ApplicationId/channels/smsEnables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
  • DELETEDelete sms channel/v1/apps/:ApplicationId/channels/smsDisables the SMS channel for an application and deletes any existing settings for the channel.
  • GETGet user endpoints/v1/apps/:ApplicationId/users/:UserIdRetrieves information about all the endpoints that are associated with a specific user ID.
  • DELETEDelete user endpoints/v1/apps/:ApplicationId/users/:UserIdDeletes all the endpoints that are associated with a specific user ID.
  • GETGet voice channel/v1/apps/:ApplicationId/channels/voiceRetrieves information about the status and settings of the voice channel for an application.
  • PUTUpdate voice channel/v1/apps/:ApplicationId/channels/voiceEnables the voice channel for an application or updates the status and settings of the voice channel for an application.
  • DELETEDelete voice channel/v1/apps/:ApplicationId/channels/voiceDisables the voice channel for an application and deletes any existing settings for the channel.
  • GETGet application date range kpi/v1/apps/:ApplicationId/kpis/daterange/:KpiName?end-time=string&next-token=string&page-size=string&start-time=stringRetrieves (queries) pre-aggregated data for a standard metric that applies to an application.
  • GETGet application settings/v1/apps/:ApplicationId/settingsRetrieves information about the settings for an application.
  • PUTUpdate application settings/v1/apps/:ApplicationId/settingsUpdates the settings for an application.
  • GETGet campaign activities/v1/apps/:ApplicationId/campaigns/:CampaignId/activities?page-size=string&token=stringRetrieves information about all the activities for a campaign.
  • GETGet campaign date range kpi/v1/apps/:ApplicationId/campaigns/:CampaignId/kpis/daterange/:KpiName?end-time=string&next-token=string&page-size=string&start-time=stringRetrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
  • GETGet campaign version/v1/apps/:ApplicationId/campaigns/:CampaignId/versions/:VersionRetrieves information about the status, configuration, and other settings for a specific version of a campaign.
  • GETGet campaign versions/v1/apps/:ApplicationId/campaigns/:CampaignId/versions?page-size=string&token=stringRetrieves information about the status, configuration, and other settings for all versions of a campaign.
  • GETGet channels/v1/apps/:ApplicationId/channelsRetrieves information about the history and status of each channel for an application.
  • GETGet export job/v1/apps/:ApplicationId/jobs/export/:JobIdRetrieves information about the status and settings of a specific export job for an application.
  • GETGet import job/v1/apps/:ApplicationId/jobs/import/:JobIdRetrieves information about the status and settings of a specific import job for an application.
  • GETGet in app messages/v1/apps/:ApplicationId/endpoints/:EndpointId/inappmessagesRetrieves the in-app messages targeted for the provided endpoint ID.
  • GETGet journey date range kpi/v1/apps/:ApplicationId/journeys/:JourneyId/kpis/daterange/:KpiName?end-time=string&next-token=string&page-size=string&start-time=stringRetrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
  • GETGet journey execution activity metrics/v1/apps/:ApplicationId/journeys/:JourneyId/activities/:JourneyActivityId/execution-metrics?next-token=string&page-size=stringRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
  • GETGet journey execution metrics/v1/apps/:ApplicationId/journeys/:JourneyId/execution-metrics?next-token=string&page-size=stringRetrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
  • GETGet journey run execution activity metrics/v1/apps/:ApplicationId/journeys/:JourneyId/runs/:RunId/activities/:JourneyActivityId/execution-metrics?next-token=string&page-size=stringRetrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
  • GETGet journey run execution metrics/v1/apps/:ApplicationId/journeys/:JourneyId/runs/:RunId/execution-metrics?next-token=string&page-size=stringRetrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
  • GETGet journey runs/v1/apps/:ApplicationId/journeys/:JourneyId/runs?page-size=string&token=stringProvides information about the runs of a journey.
  • GETGet segment export jobs/v1/apps/:ApplicationId/segments/:SegmentId/jobs/export?page-size=string&token=stringRetrieves information about the status and settings of the export jobs for a segment.
  • GETGet segment import jobs/v1/apps/:ApplicationId/segments/:SegmentId/jobs/import?page-size=string&token=stringRetrieves information about the status and settings of the import jobs for a segment.
  • GETGet segment version/v1/apps/:ApplicationId/segments/:SegmentId/versions/:VersionRetrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
  • GETGet segment versions/v1/apps/:ApplicationId/segments/:SegmentId/versions?page-size=string&token=stringRetrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
  • GETList tags for resource/v1/tags/:ResourceArnRetrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
  • POSTTag resource/v1/tags/:ResourceArnAdds one or more tags (keys and values) to an application, campaign, message template, or segment.
  • DELETEUntag resource/v1/tags/:ResourceArn?tagKeys=Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
  • GETList template versions/v1/templates/:TemplateName/:TemplateType/versions?next-token=string&page-size=stringRetrieves information about all the versions of a specific message template.
  • GETList templates/v1/templates?next-token=string&page-size=string&prefix=string&template-type=stringRetrieves information about all the message templates that are associated with your Amazon Pinpoint account.
  • POSTPhone number validate/v1/phone/number/validateRetrieves information about a phone number.
  • POSTPut events/v1/apps/:ApplicationId/eventsCreates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
  • PUTRemove attributes/v1/apps/:ApplicationId/attributes/:AttributeTypeRemoves one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will…
  • POSTSend messages/v1/apps/:ApplicationId/messagesCreates and sends a direct message.
  • POSTSend oTP message/v1/apps/:ApplicationId/otpSend an OTP message
  • POSTSend users messages/v1/apps/:ApplicationId/users-messagesCreates and sends a message to a list of users.
  • PUTUpdate endpoints batch/v1/apps/:ApplicationId/endpointsCreates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also…
  • PUTUpdate journey state/v1/apps/:ApplicationId/journeys/:JourneyId/stateCancels (stops) an active journey.
  • PUTUpdate template active version/v1/templates/:TemplateName/:TemplateType/active-versionChanges the status of a specific version of a message template to active .
  • POSTVerify oTP message/v1/apps/:ApplicationId/verify-otpVerify an OTP

API details

Base URL
https://pinpoint.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
122 operations on 63 pathsGET 53PUT 25DELETE 24POST 20
Description format
AWS Smithy model, API version 2016-12-01

How to test the Amazon Pinpoint in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Pinpoint collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get apps” (GET /v1/apps?page-size=string&token=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Pinpoint?

Doc Engage API - Amazon Pinpoint API It is listed under Communication and has 122 endpoints.

Who publishes the Amazon Pinpoint?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Pinpoint?

Requests go to https://pinpoint.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Pinpoint?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Pinpoint have?

122 operations on 63 paths (53 GET, 25 PUT, 24 DELETE, 20 POST).

Is forking the Amazon Pinpoint free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.