Amazon Pinpoint

Amazon Pinpoint Apps API

The Apps API from Amazon Pinpoint — 48 operation(s) for apps.

GitHub OpenAPI

Operations 87

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/apps Create a new Pinpoint project · Amazon Pinpoint Create App #
Ask an LLM
“How do I set up a brand-new messaging project to hold campaigns and endpoints?”
“Can I tag an application at the moment I create it?”
Tell an agent
Create a new Pinpoint application with display name and tags {app_settings}.
Spin up a fresh project for our marketing team using {app_settings}.
GET /v1/apps List all Pinpoint projects in the account · Amazon Pinpoint Get Apps #
Ask an LLM
“Which Amazon Pinpoint projects exist in my AWS account?”
“Can I page through every application I've created, a set number at a time?”
Tell an agent
List all of my Pinpoint applications.
Show the next {page_size} Pinpoint projects starting from page token {token}.
POST /v1/apps/{application-id}/campaigns Create a new campaign in a project · Amazon Pinpoint Create Campaign #
Ask an LLM
“How do I launch a new scheduled messaging campaign for my app?”
“Can I create a campaign that targets a segment in my project?”
Tell an agent
Create a new campaign in application {app} with settings {campaign}.
Set up a fresh campaign for project {app}.
GET /v1/apps/{application-id}/campaigns List all campaigns in a project · Amazon Pinpoint Get Campaigns #
Ask an LLM
“What campaigns are set up in my project, and what state is each one in?”
“Is there a way to see every campaign in an application page by page?”
Tell an agent
List every campaign in application {app}.
Show {page_size} campaigns at a time for project {app}.
POST /v1/apps/{application-id}/jobs/export Export a project's endpoints to S3 · Amazon Pinpoint Create Export Job #
Ask an LLM
“How do I export all my endpoint definitions to an S3 bucket?”
“Can I dump a project's endpoints out to S3 for analysis?”
Tell an agent
Start an export of application {app}'s endpoints to S3 using {export_settings}.
Kick off a new endpoint export job for project {app}.
GET /v1/apps/{application-id}/jobs/export List endpoint export jobs for a project · Amazon Pinpoint Get Export Jobs #
Ask an LLM
“What export jobs have run for my application and did they finish?”
“Can I see the history of all endpoint exports to S3 for a project?”
Tell an agent
List all export jobs for application {app}.
Show the status of every S3 export job in project {app}.
POST /v1/apps/{application-id}/jobs/import Import endpoints into a project from S3 · Amazon Pinpoint Create Import Job #
Ask an LLM
“How do I bulk load endpoint definitions from an S3 bucket into my project?”
“Can I import a file of contacts from S3 as endpoints?”
Tell an agent
Import endpoints from S3 into application {app} using {import_settings}.
Start a new endpoint import job for project {app}.
GET /v1/apps/{application-id}/jobs/import List endpoint import jobs for a project · Amazon Pinpoint Get Import Jobs #
Ask an LLM
“Which import jobs have loaded endpoints into my application?”
“Did any of my S3 endpoint imports fail for this project?”
Tell an agent
List all import jobs for application {app}.
Show {page_size} import jobs at a time for project {app}.
POST /v1/apps/{application-id}/journeys Create a new journey in a project · Amazon Pinpoint Create Journey #
Ask an LLM
“How do I build a multi-step customer journey for my app?”
“Can I create an automated journey inside an existing project?”
Tell an agent
Create a journey in application {app} with configuration {journey}.
Set up a new customer journey for project {app}.
GET /v1/apps/{application-id}/journeys List all journeys in a project · Amazon Pinpoint List Journeys #
Ask an LLM
“What customer journeys are configured in my application?”
“Can I see the status of each journey in a project?”
Tell an agent
List every journey in application {app}.
Show {page_size} journeys per page for project {app}.
POST /v1/apps/{application-id}/segments Create a new audience segment in a project · Amazon Pinpoint Create Segment #
Ask an LLM
“How do I define a new audience segment based on dimensions or segment groups?”
“Can I create a segment to target only certain users in my app?”
Tell an agent
Create a new segment in application {app} defined by {segment}.
Add a fresh audience segment to project {app}.
GET /v1/apps/{application-id}/segments List all audience segments in a project · Amazon Pinpoint Get Segments #
Ask an LLM
“What audience segments have I defined in my project?”
“Can I list segments and their dimensions for an application?”
Tell an agent
List all segments in application {app}.
Show {page_size} segments at a time for project {app}.
DELETE /v1/apps/{application-id}/channels/adm Disable the ADM push channel · Amazon Pinpoint Delete Adm Channel #
Ask an LLM
“How do I stop sending Amazon Device Messaging pushes from my project?”
“What happens to my ADM settings if I disable that channel?”
Tell an agent destructive · confirm first
Disable the ADM channel and delete its settings for application {app}.
Turn off Amazon Device Messaging for project {app}.
GET /v1/apps/{application-id}/channels/adm View Amazon Device Messaging channel settings · Amazon Pinpoint Get Adm Channel #
Ask an LLM
“Is the ADM channel for Kindle push notifications enabled in my project?”
“What are the current Amazon Device Messaging settings for my app?”
Tell an agent
Show the ADM channel settings for application {app}.
Check whether Amazon Device Messaging is turned on for project {app}.
PUT /v1/apps/{application-id}/channels/adm Enable or update the ADM push channel · Amazon Pinpoint Update Adm Channel #
Ask an LLM
“How do I turn on Amazon Device Messaging push for my Fire devices?”
“Can I change the credentials used by the ADM channel?”
Tell an agent
Enable the ADM channel for application {app} with settings {adm}.
Update the Amazon Device Messaging credentials on project {app}.
DELETE /v1/apps/{application-id}/channels/apns Disable the production APNs channel · Amazon Pinpoint Delete Apns Channel #
Ask an LLM
“How do I switch off production iOS push for a project?”
“Will disabling the live APNs channel delete its credentials?”
Tell an agent destructive · confirm first
Disable the production APNs channel for application {app}.
Remove the live Apple push settings from project {app}.
GET /v1/apps/{application-id}/channels/apns View the production APNs channel settings · Amazon Pinpoint Get Apns Channel #
Ask an LLM
“Is production Apple push (APNs) enabled for my iOS app's project?”
“What certificate or token settings does my APNs channel currently use?”
Tell an agent
Show the production APNs channel for application {app}.
Check the Apple Push Notification service status on project {app}.
PUT /v1/apps/{application-id}/channels/apns Enable or update the production APNs channel · Amazon Pinpoint Update Apns Channel #
Ask an LLM
“How do I enable production iOS push notifications through APNs?”
“Can I rotate the credentials on my live Apple push channel?”
Tell an agent
Enable production APNs for application {app} with settings {apns}.
Update the live Apple push channel credentials on project {app}.
DELETE /v1/apps/{application-id}/channels/apns_sandbox Disable the APNs sandbox channel · Amazon Pinpoint Delete Apns Sandbox Channel #
Ask an LLM
“How do I turn off sandbox Apple push for dev builds?”
“Can I remove the APNs sandbox credentials from my project?”
Tell an agent destructive · confirm first
Disable the APNs sandbox channel for application {app}.
Delete the development Apple push settings from project {app}.
GET /v1/apps/{application-id}/channels/apns_sandbox View the APNs sandbox channel settings · Amazon Pinpoint Get Apns Sandbox Channel #
Ask an LLM
“Is the APNs sandbox set up for testing iOS pushes in development builds?”
“What settings does my Apple push sandbox channel have?”
Tell an agent
Show the APNs sandbox channel for application {app}.
Check whether development Apple push is enabled on project {app}.
PUT /v1/apps/{application-id}/channels/apns_sandbox Enable or update the APNs sandbox channel · Amazon Pinpoint Update Apns Sandbox Channel #
Ask an LLM
“How do I enable Apple push for my development and TestFlight builds?”
“Can I update the sandbox APNs credentials without touching production?”
Tell an agent
Enable the APNs sandbox channel for application {app} with {sandbox}.
Update the development Apple push credentials on project {app}.
DELETE /v1/apps/{application-id}/channels/apns_voip Disable the production APNs VoIP channel · Amazon Pinpoint Delete Apns Voip Channel #
Ask an LLM
“How do I stop sending live VoIP pushes from my project?”
“Does disabling the APNs VoIP channel wipe its settings?”
Tell an agent destructive · confirm first
Turn off VoIP call pushes in production for application {app}.
Remove live VoIP push settings from project {app}.
GET /v1/apps/{application-id}/channels/apns_voip View the production APNs VoIP channel · Amazon Pinpoint Get Apns Voip Channel #
Ask an LLM
“Is the APNs VoIP channel enabled for my calling app?”
“What are the settings on my production VoIP push channel?”
Tell an agent
Show VoIP call push configuration (APNs VoIP, production) for application {app}.
Check the live VoIP push status on project {app}.
PUT /v1/apps/{application-id}/channels/apns_voip Enable or update the production APNs VoIP channel · Amazon Pinpoint Update Apns Voip Channel #
Ask an LLM
“How do I enable VoIP push notifications for incoming calls on iOS?”
“Can I change the credentials on my live APNs VoIP channel?”
Tell an agent
Enable production APNs VoIP for application {app} with {voip}.
Update the live VoIP push credentials on project {app}.
DELETE /v1/apps/{application-id}/channels/apns_voip_sandbox Disable the APNs VoIP sandbox channel · Amazon Pinpoint Delete Apns Voip Sandbox Channel #
Ask an LLM
“How do I turn off sandbox VoIP push for my dev builds?”
“Can I delete the VoIP sandbox credentials from a project?”
Tell an agent destructive · confirm first
Turn off development VoIP call pushes for application {app}.
Remove development VoIP push settings from project {app}.
GET /v1/apps/{application-id}/channels/apns_voip_sandbox View the APNs VoIP sandbox channel · Amazon Pinpoint Get Apns Voip Sandbox Channel #
Ask an LLM
“Is VoIP push enabled for my development iOS builds?”
“What settings does the APNs VoIP sandbox channel have?”
Tell an agent
Show the development VoIP call push configuration for application {app}.
Check the development VoIP push status on project {app}.
PUT /v1/apps/{application-id}/channels/apns_voip_sandbox Enable or update the APNs VoIP sandbox channel · Amazon Pinpoint Update Apns Voip Sandbox Channel #
Ask an LLM
“How do I test VoIP call pushes on development builds?”
“Can I set sandbox credentials for VoIP push separately from production?”
Tell an agent
Enable the APNs VoIP sandbox for application {app} with {voip_sandbox}.
Update the development VoIP push credentials on project {app}.
DELETE /v1/apps/{application-id} Delete a Pinpoint project · Amazon Pinpoint Delete App #
Ask an LLM
“How do I permanently delete a Pinpoint project I no longer use?”
“Can I remove an entire application from my account?”
Tell an agent destructive · confirm first
Delete application {app}.
Permanently remove the Pinpoint project {app}.
GET /v1/apps/{application-id} Get details of one Pinpoint project · Amazon Pinpoint Get App #
Ask an LLM
“What's the name and ARN of a specific Pinpoint project?”
“Can I look up one application by its project ID?”
Tell an agent
Get the details of application {app}.
Look up project {app} and show its name and tags.
DELETE /v1/apps/{application-id}/channels/baidu Disable the Baidu push channel · Amazon Pinpoint Delete Baidu Channel #
Ask an LLM
“How do I stop pushing through Baidu for a project?”
“Will turning off the Baidu channel delete its credentials?”
Tell an agent destructive · confirm first
Disable the Baidu channel for application {app}.
Remove Baidu Cloud Push settings from project {app}.
GET /v1/apps/{application-id}/channels/baidu View the Baidu Cloud Push channel settings · Amazon Pinpoint Get Baidu Channel #
Ask an LLM
“Is Baidu Cloud Push enabled for my Android users in China?”
“What are the Baidu channel settings in my project?”
Tell an agent
Show the Baidu channel settings for application {app}.
Check whether Baidu Cloud Push is on for project {app}.
PUT /v1/apps/{application-id}/channels/baidu Enable or update the Baidu push channel · Amazon Pinpoint Update Baidu Channel #
Ask an LLM
“How do I send push notifications through Baidu Cloud Push?”
“Can I update the API key used by my Baidu channel?”
Tell an agent
Enable the Baidu channel for application {app} with {baidu}.
Update the Baidu Cloud Push credentials on project {app}.
DELETE /v1/apps/{application-id}/campaigns/{campaign-id} Delete a campaign · Amazon Pinpoint Delete Campaign #
Ask an LLM
“How do I remove a campaign I no longer need?”
“Can I delete one campaign without affecting the rest of the project?”
Tell an agent destructive · confirm first
Delete campaign {campaign} from application {app}.
Remove campaign {campaign} from project {app} permanently.
GET /v1/apps/{application-id}/campaigns/{campaign-id} Get the settings and status of one campaign · Amazon Pinpoint Get Campaign #
Ask an LLM
“What is the current status and schedule of a particular campaign?”
“Can I see the full configuration of one campaign by its ID?”
Tell an agent
Show campaign {campaign} in application {app}.
Get the configuration of campaign {campaign} from project {app}.
PUT /v1/apps/{application-id}/campaigns/{campaign-id} Change the settings of an existing campaign · Amazon Pinpoint Update Campaign #
Ask an LLM
“How do I change the schedule or message of a campaign that already exists?”
“Can I edit a live campaign's configuration?”
Tell an agent
Update campaign {campaign} in application {app} with {changes}.
Edit the existing campaign {campaign} in project {app}.
DELETE /v1/apps/{application-id}/channels/email Disable the email channel · Amazon Pinpoint Delete Email Channel #
Ask an LLM
“How do I turn off email sending for a project?”
“Does disabling the email channel remove its configuration?”
Tell an agent destructive · confirm first
Disable the email channel for application {app}.
Remove the email channel settings from project {app}.
GET /v1/apps/{application-id}/channels/email View the email channel settings · Amazon Pinpoint Get Email Channel #
Ask an LLM
“Is email sending enabled for my project, and from which address?”
“What are the current email channel settings for my app?”
Tell an agent
Show the email channel settings for application {app}.
Check whether email is enabled on project {app}.
PUT /v1/apps/{application-id}/channels/email Enable or update the email channel · Amazon Pinpoint Update Email Channel #
Ask an LLM
“How do I enable email sending for my project?”
“Can I change the from address on my email channel?”
Tell an agent
Enable the email channel for application {app} with {email}.
Update the email sending settings on project {app}.
DELETE /v1/apps/{application-id}/endpoints/{endpoint-id} Delete one endpoint · Amazon Pinpoint Delete Endpoint #
Ask an LLM
“How do I remove a single device or address from my project?”
“Can I delete one endpoint without deleting the user's other endpoints?”
Tell an agent destructive · confirm first
Delete endpoint {endpoint} from application {app}.
Remove the single endpoint {endpoint} from project {app}.
GET /v1/apps/{application-id}/endpoints/{endpoint-id} Get the attributes of one endpoint · Amazon Pinpoint Get Endpoint #
Ask an LLM
“What address, channel and attributes are stored on a particular endpoint?”
“Can I look up a single device or email endpoint by its ID?”
Tell an agent
Show endpoint {endpoint} in application {app}.
Get the settings and attributes of endpoint {endpoint} in project {app}.
PUT /v1/apps/{application-id}/endpoints/{endpoint-id} Create or update a single endpoint · Amazon Pinpoint Update Endpoint #
Ask an LLM
“How do I register one device token or email address as an endpoint?”
“Can I set custom attributes on a single endpoint, and do they overwrite old values?”
Tell an agent
Create or update endpoint {endpoint} in application {app} with {endpoint_settings}.
Set custom attributes on the single endpoint {endpoint} in project {app}.
DELETE /v1/apps/{application-id}/eventstream Delete a project's event stream · Amazon Pinpoint Delete Event Stream #
Ask an LLM
“How do I stop exporting events from my project to a stream?”
“Can I remove the event stream configuration entirely?”
Tell an agent destructive · confirm first
Delete the event stream for application {app}.
Stop streaming events from project {app}.
GET /v1/apps/{application-id}/eventstream View a project's event stream settings · Amazon Pinpoint Get Event Stream #
Ask an LLM
“Where are my project's engagement events being streamed to?”
“What Kinesis stream and IAM role does my event stream use?”
Tell an agent
Show the event stream settings for application {app}.
Check which stream project {app} publishes events to.
POST /v1/apps/{application-id}/eventstream Create or update a project's event stream · Amazon Pinpoint Put Event Stream #
Ask an LLM
“How do I stream my messaging events to Kinesis?”
“Can I change the IAM role used to publish my event stream?”
Tell an agent
Configure the event stream for application {app} with {stream}.
Point project {app}'s event stream at a new destination.
DELETE /v1/apps/{application-id}/channels/gcm Disable the GCM / Firebase push channel · Amazon Pinpoint Delete Gcm Channel #
Ask an LLM
“How do I stop Android pushes through Firebase for a project?”
“Will disabling GCM delete its stored credentials?”
Tell an agent destructive · confirm first
Disable the GCM channel for application {app}.
Remove the Firebase push settings from project {app}.
GET /v1/apps/{application-id}/channels/gcm View the GCM / Firebase push channel settings · Amazon Pinpoint Get Gcm Channel #
Ask an LLM
“Is Firebase Cloud Messaging push enabled for my Android app?”
“What are the GCM channel settings in my project?”
Tell an agent
Show the GCM channel settings for application {app}.
Check whether Firebase push is on for project {app}.
PUT /v1/apps/{application-id}/channels/gcm Enable or update the GCM / Firebase push channel · Amazon Pinpoint Update Gcm Channel #
Ask an LLM
“How do I enable Android push notifications through Firebase Cloud Messaging?”
“Can I update the FCM credentials on my GCM channel?”
Tell an agent
Enable the GCM channel for application {app} with {gcm}.
Update the Firebase push credentials on project {app}.
DELETE /v1/apps/{application-id}/journeys/{journey-id} Delete a journey · Amazon Pinpoint Delete Journey #
Ask an LLM
“How do I permanently remove a journey from my project?”
“Can I delete a journey rather than just stopping it?”
Tell an agent destructive · confirm first
Delete journey {journey} from application {app}.
Permanently remove journey {journey} from project {app}.
GET /v1/apps/{application-id}/journeys/{journey-id} Get the configuration of one journey · Amazon Pinpoint Get Journey #
Ask an LLM
“What activities and status does a specific journey have?”
“Can I pull up one journey's full configuration by its ID?”
Tell an agent
Show journey {journey} in application {app}.
Get the settings of journey {journey} from project {app}.
PUT /v1/apps/{application-id}/journeys/{journey-id} Change the configuration of an existing journey · Amazon Pinpoint Update Journey #
Ask an LLM
“How do I edit the steps of a journey I've already built?”
“Can I change an existing journey's schedule or activities?”
Tell an agent
Update journey {journey} in application {app} with {changes}.
Edit the configuration of existing journey {journey} in project {app}.
DELETE /v1/apps/{application-id}/segments/{segment-id} Delete a segment · Amazon Pinpoint Delete Segment #
Ask an LLM
“How do I get rid of an audience segment I no longer use?”
“Can I delete one segment from a project?”
Tell an agent destructive · confirm first
Delete segment {segment} from application {app}.
Remove segment {segment} from project {app} permanently.
GET /v1/apps/{application-id}/segments/{segment-id} Get the definition of one segment · Amazon Pinpoint Get Segment #
Ask an LLM
“What dimensions define a particular audience segment?”
“Can I look up the latest settings of one segment by ID?”
Tell an agent
Show segment {segment} in application {app}.
Get the current definition of segment {segment} from project {app}.
PUT /v1/apps/{application-id}/segments/{segment-id} Change the definition of an existing segment · Amazon Pinpoint Update Segment #
Ask an LLM
“How do I change the targeting rules of a segment I already have?”
“Can I update the dimensions on an existing segment?”
Tell an agent
Update segment {segment} in application {app} with {changes}.
Edit the dimensions of existing segment {segment} in project {app}.
DELETE /v1/apps/{application-id}/channels/sms Disable the SMS channel · Amazon Pinpoint Delete Sms Channel #
Ask an LLM
“How do I stop sending text messages from a project?”
“Does turning off SMS delete its channel settings?”
Tell an agent destructive · confirm first
Disable the SMS channel for application {app}.
Remove the text messaging settings from project {app}.
GET /v1/apps/{application-id}/channels/sms View the SMS channel settings · Amazon Pinpoint Get Sms Channel #
Ask an LLM
“Is SMS sending enabled for my project, and with what sender ID?”
“What are the current text message channel settings?”
Tell an agent
Show the SMS channel settings for application {app}.
Check whether text messaging is on for project {app}.
PUT /v1/apps/{application-id}/channels/sms Enable or update the SMS channel · Amazon Pinpoint Update Sms Channel #
Ask an LLM
“How do I enable text messaging for my project?”
“Can I change the sender ID used by the SMS channel?”
Tell an agent
Enable the SMS channel for application {app} with {sms}.
Update the text message sending settings on project {app}.
DELETE /v1/apps/{application-id}/users/{user-id} Delete all endpoints belonging to a user · Amazon Pinpoint Delete User Endpoints #
Ask an LLM
“How do I erase every endpoint for a user who asked to be forgotten?”
“Can I remove all of one user's devices and addresses at once?”
Tell an agent destructive · confirm first
Delete all endpoints for user {user} in application {app}.
Wipe every device and address tied to user {user} in project {app}.
GET /v1/apps/{application-id}/users/{user-id} List all endpoints belonging to a user · Amazon Pinpoint Get User Endpoints #
Ask an LLM
“Which devices and addresses are registered to a given user ID?”
“Can I see every endpoint tied to one customer?”
Tell an agent
List all endpoints for user {user} in application {app}.
Show every device and address registered to user {user} in project {app}.
DELETE /v1/apps/{application-id}/channels/voice Disable the voice channel · Amazon Pinpoint Delete Voice Channel #
Ask an LLM
“How do I turn off voice messaging for a project?”
“Will disabling the voice channel delete its settings?”
Tell an agent destructive · confirm first
Disable the voice channel for application {app}.
Remove the voice call settings from project {app}.
GET /v1/apps/{application-id}/channels/voice View the voice channel settings · Amazon Pinpoint Get Voice Channel #
Ask an LLM
“Is voice messaging enabled for my project?”
“What are the current settings on the voice call channel?”
Tell an agent
Show the voice channel settings for application {app}.
Check whether voice calls are enabled on project {app}.
PUT /v1/apps/{application-id}/channels/voice Enable or update the voice channel · Amazon Pinpoint Update Voice Channel #
Ask an LLM
“How do I enable voice messages for my project?”
“Can I switch the voice channel on or off with an update?”
Tell an agent
Enable the voice channel for application {app} with {voice}.
Update the voice call channel settings on project {app}.
GET /v1/apps/{application-id}/kpis/daterange/{kpi-name} Get a project-level metric over a date range · Amazon Pinpoint Get Application Date Range Kpi #
Ask an LLM
“What were my project's overall delivery or engagement numbers last month?”
“Can I query an application-wide KPI between two dates?”
Tell an agent
Get the {kpi} metric for application {app} from {start} to {end}.
Show project {app}'s {kpi} KPI for the default date range.
GET /v1/apps/{application-id}/settings View a project's default settings · Amazon Pinpoint Get Application Settings #
Ask an LLM
“What quiet hours and sending limits apply by default to my project?”
“Can I see the default campaign hook and limits for an application?”
Tell an agent
Show the default settings for application {app}.
Get project {app}'s default quiet time and limits.
PUT /v1/apps/{application-id}/settings Change a project's default settings · Amazon Pinpoint Update Application Settings #
Ask an LLM
“How do I set default quiet hours for every campaign in a project?”
“Can I change the default message limits for an application?”
Tell an agent
Update the default settings for application {app} to {settings}.
Change project {app}'s default quiet time and sending limits.
GET /v1/apps/{application-id}/campaigns/{campaign-id}/activities List the activities run by a campaign · Amazon Pinpoint Get Campaign Activities #
Ask an LLM
“What activities has a campaign run, and did they succeed?”
“Can I see each scheduled run of a recurring campaign?”
Tell an agent
List the activities for campaign {campaign} in application {app}.
Show the run history of campaign {campaign} in project {app}.
GET /v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name} Get a campaign metric over a date range · Amazon Pinpoint Get Campaign Date Range Kpi #
Ask an LLM
“How many messages did a specific campaign deliver between two dates?”
“What KPI data can I pull for just one campaign?”
Tell an agent
Get the {kpi} metric for campaign {campaign} in application {app} from {start} to {end}.
Show campaign {campaign}'s {kpi} KPI in project {app}.
GET /v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version} Get one specific version of a campaign · Amazon Pinpoint Get Campaign Version #
Ask an LLM
“What did an earlier version of my campaign look like?”
“Can I retrieve a campaign's configuration as of a given version number?”
Tell an agent
Show version {version} of campaign {campaign} in application {app}.
Get the settings of campaign {campaign} version {version} from project {app}.
GET /v1/apps/{application-id}/campaigns/{campaign-id}/versions List every version of a campaign · Amazon Pinpoint Get Campaign Versions #
Ask an LLM
“How has a campaign's configuration changed over time?”
“Can I list all saved versions of one campaign?”
Tell an agent
List all versions of campaign {campaign} in application {app}.
Show the version history of campaign {campaign} in project {app}.
GET /v1/apps/{application-id}/channels See the status of every channel in a project · Amazon Pinpoint Get Channels #
Ask an LLM
“Which messaging channels are enabled across my whole project?”
“Can I get a single overview of push, email, SMS and voice channel status?”
Tell an agent
Show the status of all channels for application {app}.
Give me an overview of every channel in project {app}.
GET /v1/apps/{application-id}/jobs/export/{job-id} Check the status of one export job · Amazon Pinpoint Get Export Job #
Ask an LLM
“Has my endpoint export to S3 finished yet?”
“Can I check the progress and failures of a single export job?”
Tell an agent
Show export job {job} in application {app}.
Check whether export job {job} for project {app} completed.
GET /v1/apps/{application-id}/jobs/import/{job-id} Check the status of one import job · Amazon Pinpoint Get Import Job #
Ask an LLM
“Did my endpoint import from S3 succeed?”
“How many records failed in a particular import job?”
Tell an agent
Show import job {job} in application {app}.
Check whether import job {job} for project {app} completed.
GET /v1/apps/{application-id}/endpoints/{endpoint-id}/inappmessages Get in-app messages targeted at an endpoint · Amazon Pinpoint Get in App Messages #
Ask an LLM
“Which in-app messages should my app display to this device?”
“Can I fetch the in-app messages queued for a specific endpoint?”
Tell an agent
Get the in-app messages for endpoint {endpoint} in application {app}.
Fetch in-app messages to show on device endpoint {endpoint} in project {app}.
GET /v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name} Get a journey engagement metric over a date range · Amazon Pinpoint Get Journey Date Range Kpi #
Ask an LLM
“What engagement numbers did a journey produce over a date range?”
“Can I query a single journey's KPI between two dates?”
Tell an agent
Get the {kpi} engagement metric for journey {journey} in application {app} from {start} to {end}.
Show journey {journey}'s {kpi} KPI in project {app}.
GET /v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics Get execution metrics for one journey activity · Amazon Pinpoint Get Journey Execution Activity Metrics #
Ask an LLM
“How many participants passed through a particular step of my journey?”
“Can I see execution metrics for a single journey activity?”
Tell an agent
Get execution metrics for activity {activity} of journey {journey} in application {app}.
Show how step {activity} of journey {journey} is performing in project {app}.
GET /v1/apps/{application-id}/journeys/{journey-id}/execution-metrics Get overall execution metrics for a journey · Amazon Pinpoint Get Journey Execution Metrics #
Ask an LLM
“How many endpoints have entered or finished a journey overall?”
“What are the whole-journey execution numbers for a running journey?”
Tell an agent
Get the overall execution metrics for journey {journey} in application {app}.
Show how many participants journey {journey} has processed in project {app}.
GET /v1/apps/{application-id}/segments/{segment-id}/jobs/export List export jobs for one segment · Amazon Pinpoint Get Segment Export Jobs #
Ask an LLM
“Which export jobs have run for a particular segment?”
“Can I see only the S3 exports that came from one segment?”
Tell an agent
List the export jobs for segment {segment} in application {app}.
Show export job status for segment {segment} in project {app}.
GET /v1/apps/{application-id}/segments/{segment-id}/jobs/import List import jobs for one segment · Amazon Pinpoint Get Segment Import Jobs #
Ask an LLM
“What import jobs created or fed a particular segment?”
“Can I check the imports tied to just one segment?”
Tell an agent
List the import jobs for segment {segment} in application {app}.
Show import job status for segment {segment} in project {app}.
GET /v1/apps/{application-id}/segments/{segment-id}/versions/{version} Get one specific version of a segment · Amazon Pinpoint Get Segment Version #
Ask an LLM
“What did a segment's definition look like in an earlier version?”
“Can I retrieve a segment's dimensions as of a given version number?”
Tell an agent
Show version {version} of segment {segment} in application {app}.
Get segment {segment} as it was at version {version} in project {app}.
GET /v1/apps/{application-id}/segments/{segment-id}/versions List every version of a segment · Amazon Pinpoint Get Segment Versions #
Ask an LLM
“How has a segment's targeting changed over time?”
“Can I list all saved versions of one segment?”
Tell an agent
List all versions of segment {segment} in application {app}.
Show the version history of segment {segment} in project {app}.
POST /v1/apps/{application-id}/events Record events for endpoints · Amazon Pinpoint Put Events #
Ask an LLM
“How do I send app usage events so they can trigger journeys and analytics?”
“Can I record events and update endpoint data in the same call?”
Tell an agent
Record this batch of events {events} in application {app}.
Submit custom events for my endpoints to project {app}.
PUT /v1/apps/{application-id}/attributes/{attribute-type} Remove attributes from every endpoint in a project · Amazon Pinpoint Remove Attributes #
Ask an LLM
“How do I drop a custom attribute from all endpoints at once?”
“Can I remove endpoint metrics or user attributes across a whole application?”
Tell an agent destructive · confirm first
Remove {attribute_type} attributes {attributes} from all endpoints in application {app}.
Strip the {attribute_type} attribute type from every endpoint in project {app}.
POST /v1/apps/{application-id}/messages Send a direct message to addresses or endpoints · Amazon Pinpoint Send Messages #
Ask an LLM
“How do I send a one-off transactional SMS, email or push without a campaign?”
“Can I message specific addresses or endpoint IDs directly?”
Tell an agent
Send the direct message {message} from application {app}.
Send a one-off transactional message through project {app}.
POST /v1/apps/{application-id}/otp Send a one-time passcode · Amazon Pinpoint Send O T P Message #
Ask an LLM
“How do I text a one-time verification code to a user's phone?”
“Can Pinpoint generate and send an OTP for sign-in?”
Tell an agent
Send a one-time passcode with {otp_request} from application {app}.
Text a verification code to the user through project {app}.
POST /v1/apps/{application-id}/users-messages Send a message to all endpoints of listed users · Amazon Pinpoint Send Users Messages #
Ask an LLM
“How do I message users by user ID so it reaches all their devices?”
“Can I send one message to every endpoint belonging to a list of users?”
Tell an agent
Send {user_message} to the listed users in application {app}.
Message every device of a set of user IDs in project {app}.
PUT /v1/apps/{application-id}/endpoints Create or update endpoints in bulk · Amazon Pinpoint Update Endpoints Batch #
Ask an LLM
“How do I register many devices or addresses in one request?”
“Can I update attributes on a batch of endpoints at once?”
Tell an agent
Create or update this batch of endpoints {batch} in application {app}.
Bulk upsert endpoints into project {app}.
PUT /v1/apps/{application-id}/journeys/{journey-id}/state Stop an active journey · Amazon Pinpoint Update Journey State #
Ask an LLM
“How do I cancel a journey that's currently running?”
“Can I halt an active journey without deleting it?”
Tell an agent destructive · confirm first
Cancel active journey {journey} in application {app}.
Set journey {journey} in project {app} to state {state}.
POST /v1/apps/{application-id}/verify-otp Verify a one-time passcode · Amazon Pinpoint Verify O T P Message #
Ask an LLM
“How do I check whether the code a user typed matches the OTP I sent?”
“Can I validate a verification code server-side?”
Tell an agent
Verify the one-time passcode {otp_check} for application {app}.
Check the user's entered verification code in project {app}.

Documentation

📖
Documentation
https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html
📖
APIReference
https://docs.aws.amazon.com/pinpoint/latest/apireference/welcome.html
📖
GettingStarted
https://aws.amazon.com/pinpoint/getting-started/
📖
RateLimits
https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html
📖
Authentication
https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/openapi/amazon-pinpoint-apps-api-openapi.yml

Other Resources

🔗
Pricing
https://aws.amazon.com/pinpoint/pricing/
🔗
FAQ
https://aws.amazon.com/pinpoint/faqs/
🔗
Features
https://aws.amazon.com/pinpoint/features/
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-batch-update-endpoints-send-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-build-segment-campaign-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-configure-event-stream-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-launch-campaign-await-status-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-launch-journey-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-message-user-across-endpoints-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-pause-active-journey-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-provision-journey-end-to-end-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-provision-project-with-settings-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-provision-project-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-publish-and-activate-template-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-publish-in-app-template-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-publish-voice-template-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-push-template-campaign-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-reversion-segment-campaign-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-send-and-verify-otp-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-stage-or-launch-campaign-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-template-driven-campaign-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/arazzo/amazon-pinpoint-update-endpoint-send-message-workflow.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-pinpoint:amazon-pinpoint-apps-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-pinpoint-apps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2016-12-01
  x-release: v4
  title: Amazon Pinpoint Apps API
  description: Doc Engage API - Amazon Pinpoint API
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: pinpoint
  x-aws-signingName: mobiletargeting
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pinpoint-2016-12-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://pinpoint.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Pinpoint multi-region endpoint
- url: https://pinpoint.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Pinpoint multi-region endpoint
- url: http://pinpoint.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)
- url: https://pinpoint.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:


# --- truncated at 32 KB (554 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/openapi/amazon-pinpoint-apps-api-openapi.yml