How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Pinpoint Templates API

The Templates API from Amazon Pinpoint — 8 operation(s) for templates.

Amazon Pinpoint Templates 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 Templates. 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 23 operations across 8 paths, and defines 62 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.

23 operations 8 paths 62 schemas 5 DELETE7 GET5 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://pinpoint.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Pinpoint Templates 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 23

Across 8 paths, the API surfaces 23 operations — 5 DELETE, 7 GET, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Templates 23
POST
/v1/templates/{template-name}/email
Amazon Pinpoint Create Email Template
CreateEmailTemplate 8 params body → 201480481482483484
DELETE
/v1/templates/{template-name}/email
Amazon Pinpoint Delete Email Template
DeleteEmailTemplate 9 params → 202480481482483484485486
GET
/v1/templates/{template-name}/email
Amazon Pinpoint Get Email Template
GetEmailTemplate 9 params → 200480481482483484485486
PUT
/v1/templates/{template-name}/email
Amazon Pinpoint Update Email Template
UpdateEmailTemplate 10 params body → 202480481482483484485486
POST
/v1/templates/{template-name}/inapp
Amazon Pinpoint Create in App Template
CreateInAppTemplate 8 params body → 201480481482483484
DELETE
/v1/templates/{template-name}/inapp
Amazon Pinpoint Delete in App Template
DeleteInAppTemplate 9 params → 202480481482483484485486
GET
/v1/templates/{template-name}/inapp
Amazon Pinpoint Get in App Template
GetInAppTemplate 9 params → 200480481482483484485486
PUT
/v1/templates/{template-name}/inapp
Amazon Pinpoint Update in App Template
UpdateInAppTemplate 10 params body → 202480481482483484485486
POST
/v1/templates/{template-name}/push
Amazon Pinpoint Create Push Template
CreatePushTemplate 8 params body → 201480481482483484
DELETE
/v1/templates/{template-name}/push
Amazon Pinpoint Delete Push Template
DeletePushTemplate 9 params → 202480481482483484485486
GET
/v1/templates/{template-name}/push
Amazon Pinpoint Get Push Template
GetPushTemplate 9 params → 200480481482483484485486
PUT
/v1/templates/{template-name}/push
Amazon Pinpoint Update Push Template
UpdatePushTemplate 10 params body → 202480481482483484485486
POST
/v1/templates/{template-name}/sms
Amazon Pinpoint Create Sms Template
CreateSmsTemplate 8 params body → 201480481482483484
DELETE
/v1/templates/{template-name}/sms
Amazon Pinpoint Delete Sms Template
DeleteSmsTemplate 9 params → 202480481482483484485486
GET
/v1/templates/{template-name}/sms
Amazon Pinpoint Get Sms Template
GetSmsTemplate 9 params → 200480481482483484485486
PUT
/v1/templates/{template-name}/sms
Amazon Pinpoint Update Sms Template
UpdateSmsTemplate 10 params body → 202480481482483484485486
POST
/v1/templates/{template-name}/voice
Amazon Pinpoint Create Voice Template
CreateVoiceTemplate 8 params body → 201480481482483484
DELETE
/v1/templates/{template-name}/voice
Amazon Pinpoint Delete Voice Template
DeleteVoiceTemplate 9 params → 202480481482483484485486
GET
/v1/templates/{template-name}/voice
Amazon Pinpoint Get Voice Template
GetVoiceTemplate 9 params → 200480481482483484485486
PUT
/v1/templates/{template-name}/voice
Amazon Pinpoint Update Voice Template
UpdateVoiceTemplate 10 params body → 202480481482483484485486
GET
/v1/templates/{template-name}/{template-type}/versions
Amazon Pinpoint List Template Versions
ListTemplateVersions 11 params → 200480481482483484485486
GET
/v1/templates
Amazon Pinpoint List Templates
ListTemplates 11 params → 200480481482483484
PUT
/v1/templates/{template-name}/{template-type}/active-version
Amazon Pinpoint Update Template Active Version
UpdateTemplateActiveVersion 9 params body → 200480481482483484485486

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are PushNotificationTemplateResponse (15 properties), EmailTemplateResponse (13 properties), VoiceTemplateResponse (12 properties), InAppTemplateResponse (11 properties). Each schema is shown below with its type and property counts.

NotFoundException
DeleteSmsTemplateResponse
object
1 property 1 required
MessageBody
object
Provides information about an API request or response.
2 properties
ListOfTemplateVersionResponse
array
Action
string
ForbiddenException
PushNotificationTemplateResponse
object
Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.
15 properties 4 required
UpdateTemplateActiveVersionResponse
object
1 property 1 required
MethodNotAllowedException
GetInAppTemplateResponse
object
1 property 1 required
APNSPushNotificationTemplate
object
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notifi…
7 properties
CreateTemplateMessageBody
object
Provides information about a request to create a message template.
3 properties
InAppMessageBodyConfig
object
Text config for Message Body.
3 properties 3 required
DeleteEmailTemplateResponse
object
1 property 1 required
ListTemplatesResponse
object
1 property 1 required
CreateVoiceTemplateResponse
object
1 property 1 required
GetSmsTemplateResponse
object
1 property 1 required
DefaultButtonConfiguration
object
Default button configuration.
6 properties 2 required
UpdateVoiceTemplateResponse
object
1 property 1 required
TemplateCreateMessageBody
object
Provides information about a request to create a message template.
3 properties
ListOfTemplateResponse
array
GetEmailTemplateResponse
object
1 property 1 required
__string
string
OverrideButtonConfiguration
object
Override button configuration.
2 properties 1 required
__integer
integer
GetVoiceTemplateResponse
object
1 property 1 required
PayloadTooLargeException
SMSTemplateResponse
object
Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
11 properties 4 required
CreateInAppTemplateResponse
object
1 property 1 required
InAppMessageHeaderConfig
object
Text config for Message Header.
3 properties 3 required
CreateSmsTemplateResponse
object
1 property 1 required
TemplateType
string
InAppMessageContent
object
The configuration for the message content.
6 properties
InAppTemplateResponse
object
In-App Template Response.
11 properties 4 required
Alignment
string
ButtonAction
string
TooManyRequestsException
DeletePushTemplateResponse
object
1 property 1 required
UpdateEmailTemplateResponse
object
1 property 1 required
EmailTemplateResponse
object
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
13 properties 4 required
TemplateVersionsResponse
object
Provides information about all the versions of a specific message template.
4 properties 1 required
ListTemplateVersionsResponse
object
1 property 1 required
Layout
string
ListOfInAppMessageContent
array
CreatePushTemplateResponse
object
1 property 1 required
UpdateSmsTemplateResponse
object
1 property 1 required
InAppMessageButton
object
Button Config for an in-app message.
4 properties
TemplateResponse
object
Provides information about a message template that's associated with your Amazon Pinpoint account.
9 properties 4 required
CreateEmailTemplateResponse
object
1 property 1 required
InternalServerErrorException
DefaultPushNotificationTemplate
object
Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.
5 properties
MapOf__string
object
BadRequestException
UpdatePushTemplateResponse
object
1 property 1 required
TemplateVersionResponse
object
Provides information about a specific version of a message template.
7 properties 4 required
AndroidPushNotificationTemplate
object
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Mess…
9 properties
GetPushTemplateResponse
object
1 property 1 required
UpdateInAppTemplateResponse
object
1 property 1 required
DeleteInAppTemplateResponse
object
1 property 1 required
TemplatesResponse
object
Provides information about all the message templates that are associated with your Amazon Pinpoint account.
2 properties 1 required
VoiceTemplateResponse
object
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
12 properties 4 required
DeleteVoiceTemplateResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-pinpoint-templates-api-openapi.yml Raw ↑

Other APIs Amazon Pinpoint publishes across the network.

Amazon Pinpoint Applications API
Amazon Pinpoint Apps API
Amazon Pinpoint Phone API
Amazon Pinpoint Recommenders API
Amazon Pinpoint Tags API
Where this information came from

This is an independent, third-party profile of Amazon Pinpoint Templates 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.