Amazon Pinpoint · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Amazon Pinpoint Templates API
24 actions
24 updates
phrasing
extends
openapi/amazon-pinpoint-templates-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Amazon Pinpoint's API. It is a proposal applied on top of the contract, not a document Amazon Pinpoint publishes.
What the actions change
x-apievangelist-phrasing
Targets 24 · first 16 shown; the file carries all of them
$.info
$.paths['/v1/templates/{template-name}/email'].get
$.paths['/v1/templates/{template-name}/email'].put
$.paths['/v1/templates/{template-name}/email'].post
$.paths['/v1/templates/{template-name}/email'].delete
$.paths['/v1/templates/{template-name}/inapp'].get
$.paths['/v1/templates/{template-name}/inapp'].put
$.paths['/v1/templates/{template-name}/inapp'].post
$.paths['/v1/templates/{template-name}/inapp'].delete
$.paths['/v1/templates/{template-name}/push'].get
$.paths['/v1/templates/{template-name}/push'].put
$.paths['/v1/templates/{template-name}/push'].post
$.paths['/v1/templates/{template-name}/push'].delete
$.paths['/v1/templates/{template-name}/sms'].get
$.paths['/v1/templates/{template-name}/sms'].put
$.paths['/v1/templates/{template-name}/sms'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Amazon Pinpoint Templates API
version: 1.0.0
extends: openapi/amazon-pinpoint-templates-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 23
- target: $.paths['/v1/templates/{template-name}/email'].get
update:
x-apievangelist-phrasing:
intent: Get an email message template
effect: read
questions:
- What subject and body does my saved email template contain?
- Can I fetch an older version of an email template?
instructions:
- text: Show the email template {template}.
slots:
template: path.template-name
- text: Get version {version} of email template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/email'].put
update:
x-apievangelist-phrasing:
intent: Update an existing email template
effect: write
questions:
- How do I edit the HTML of an email template I already saved?
- Can I save email template changes as a new version instead of overwriting?
instructions:
- text: Update email template {template} with {content}.
slots:
template: path.template-name
content: requestBody.EmailTemplateRequest
- text: 'Save my edits to email template {template} as a new version: {create_new_version}.'
slots:
template: path.template-name
create_new_version: query.create-new-version
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/email'].post
update:
x-apievangelist-phrasing:
intent: Create a new email message template
effect: write
questions:
- How do I create a reusable email template with a subject and HTML body?
- Can I set up a new template for email campaigns?
instructions:
- text: Create an email template named {template} with {content}.
slots:
template: path.template-name
content: requestBody.EmailTemplateRequest
- text: Make a new email template called {template}.
slots:
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/email'].delete
update:
x-apievangelist-phrasing:
intent: Delete an email message template
effect: destructive
questions:
- How do I delete an email template I no longer use?
- Can I remove only one version of an email template?
instructions:
- text: Delete the email template {template}.
slots:
template: path.template-name
- text: Remove version {version} of email template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/inapp'].get
update:
x-apievangelist-phrasing:
intent: Get an in-app message template
effect: read
questions:
- What layout and content does my in-app message template have?
- Can I view a specific version of an in-app template?
instructions:
- text: Show the in-app template {template}.
slots:
template: path.template-name
- text: Get version {version} of in-app message template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/inapp'].put
update:
x-apievangelist-phrasing:
intent: Update an existing in-app message template
effect: write
questions:
- How do I change the content of an in-app message template I already have?
- Can I keep the old in-app template version when I save changes?
instructions:
- text: Update in-app template {template} with {content}.
slots:
template: path.template-name
content: requestBody.InAppTemplateRequest
- text: 'Save changes to in-app template {template} as new version: {create_new_version}.'
slots:
template: path.template-name
create_new_version: query.create-new-version
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/inapp'].post
update:
x-apievangelist-phrasing:
intent: Create a new in-app message template
effect: write
questions:
- How do I design a reusable in-app message template?
- Can I create a template for banners or modals shown inside my app?
instructions:
- text: Create an in-app message template named {template} with {content}.
slots:
template: path.template-name
content: requestBody.InAppTemplateRequest
- text: Make a new in-app template called {template}.
slots:
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/inapp'].delete
update:
x-apievangelist-phrasing:
intent: Delete an in-app message template
effect: destructive
questions:
- How do I delete an in-app message template?
- Can I remove a single version of an in-app template?
instructions:
- text: Delete the in-app template {template}.
slots:
template: path.template-name
- text: Remove version {version} of in-app template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/push'].get
update:
x-apievangelist-phrasing:
intent: Get a push notification template
effect: read
questions:
- What title and body are in my push notification template?
- Can I look at an earlier version of a push template?
instructions:
- text: Show the push notification template {template}.
slots:
template: path.template-name
- text: Get version {version} of push template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/push'].put
update:
x-apievangelist-phrasing:
intent: Update an existing push notification template
effect: write
questions:
- How do I change the wording of a push notification template?
- Can I save push template edits as a new version?
instructions:
- text: Update push template {template} with {content}.
slots:
template: path.template-name
content: requestBody.PushNotificationTemplateRequest
- text: 'Save changes to push template {template} as new version: {create_new_version}.'
slots:
template: path.template-name
create_new_version: query.create-new-version
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/push'].post
update:
x-apievangelist-phrasing:
intent: Create a new push notification template
effect: write
questions:
- How do I create a reusable template for mobile push notifications?
- Can one push template cover both iOS and Android messages?
instructions:
- text: Create a push notification template named {template} with {content}.
slots:
template: path.template-name
content: requestBody.PushNotificationTemplateRequest
- text: Make a new push template called {template}.
slots:
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/push'].delete
update:
x-apievangelist-phrasing:
intent: Delete a push notification template
effect: destructive
questions:
- How do I delete a push notification template?
- Can I delete just one version of a push template?
instructions:
- text: Delete the push notification template {template}.
slots:
template: path.template-name
- text: Remove version {version} of push template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/sms'].get
update:
x-apievangelist-phrasing:
intent: Get an SMS message template
effect: read
questions:
- What text is saved in my SMS template?
- Can I retrieve an older version of a text message template?
instructions:
- text: Show the SMS template {template}.
slots:
template: path.template-name
- text: Get version {version} of text message template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/sms'].put
update:
x-apievangelist-phrasing:
intent: Update an existing SMS template
effect: write
questions:
- How do I change the wording of an SMS template I already created?
- Can I keep the previous text message template as its own version?
instructions:
- text: Update SMS template {template} with {content}.
slots:
template: path.template-name
content: requestBody.SMSTemplateRequest
- text: 'Save edits to text message template {template} as new version: {create_new_version}.'
slots:
template: path.template-name
create_new_version: query.create-new-version
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/sms'].post
update:
x-apievangelist-phrasing:
intent: Create a new SMS message template
effect: write
questions:
- How do I save a reusable text message template?
- Can I create an SMS template with personalized variables?
instructions:
- text: Create an SMS template named {template} with {content}.
slots:
template: path.template-name
content: requestBody.SMSTemplateRequest
- text: Make a new text message template called {template}.
slots:
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/sms'].delete
update:
x-apievangelist-phrasing:
intent: Delete an SMS message template
effect: destructive
questions:
- How do I delete an SMS template?
- Can I remove one version of a text message template?
instructions:
- text: Delete the SMS template {template}.
slots:
template: path.template-name
- text: Remove version {version} of text message template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/voice'].get
update:
x-apievangelist-phrasing:
intent: Get a voice message template
effect: read
questions:
- What script and voice settings are in my voice template?
- Can I view an earlier version of a voice message template?
instructions:
- text: Show the voice template {template}.
slots:
template: path.template-name
- text: Get version {version} of voice message template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/voice'].put
update:
x-apievangelist-phrasing:
intent: Update an existing voice message template
effect: write
questions:
- How do I change the spoken script of a voice template?
- Can I save voice template changes as a new version?
instructions:
- text: Update voice template {template} with {content}.
slots:
template: path.template-name
content: requestBody.VoiceTemplateRequest
- text: 'Save changes to voice template {template} as new version: {create_new_version}.'
slots:
template: path.template-name
create_new_version: query.create-new-version
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/voice'].post
update:
x-apievangelist-phrasing:
intent: Create a new voice message template
effect: write
questions:
- How do I create a reusable script for automated voice calls?
- Can I set up a template for voice messages?
instructions:
- text: Create a voice message template named {template} with {content}.
slots:
template: path.template-name
content: requestBody.VoiceTemplateRequest
- text: Make a new voice template called {template}.
slots:
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/voice'].delete
update:
x-apievangelist-phrasing:
intent: Delete a voice message template
effect: destructive
questions:
- How do I delete a voice message template?
- Can I remove one version of a voice template only?
instructions:
- text: Delete the voice template {template}.
slots:
template: path.template-name
- text: Remove version {version} of voice template {template}.
slots:
version: query.version
template: path.template-name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/{template-type}/versions'].get
update:
x-apievangelist-phrasing:
intent: List all versions of a message template
effect: read
questions:
- What versions exist for one of my message templates?
- Which version of a template is currently active?
instructions:
- text: List all versions of the {template_type} template {template}.
slots:
template_type: path.template-type
template: path.template-name
- text: Show the version history of {template_type} template {template}, {page_size} per page.
slots:
template_type: path.template-type
template: path.template-name
page_size: query.page-size
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates'].get
update:
x-apievangelist-phrasing:
intent: List message templates in the account
effect: read
questions:
- Which message templates have I saved in my Amazon Pinpoint account?
- Can I filter my templates by channel type or name prefix?
instructions:
- text: List all of my message templates.
- text: List {template_type} templates whose names start with {prefix}.
slots:
template_type: query.template-type
prefix: query.prefix
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/templates/{template-name}/{template-type}/active-version'].put
update:
x-apievangelist-phrasing:
intent: Set which template version is active
effect: write
questions:
- How do I roll a message template back to an earlier version?
- Can I choose which version of a template campaigns use by default?
instructions:
- text: Make {active_version} the active version of {template_type} template {template}.
slots:
active_version: requestBody.TemplateActiveVersionRequest
template_type: path.template-type
template: path.template-name
- text: Activate a different version of the {template_type} template {template}.
slots:
template_type: path.template-type
template: path.template-name
method: generated
generated: '2026-09-26'