openapi: 3.0.0
info:
version: 2016-12-01
x-release: v4
title: Amazon Pinpoint Applications Templates 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:
- name: Templates
paths:
/v1/templates/{template-name}/email:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateEmailTemplate
description: Creates a message template for messages that are sent through the email channel.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEmailTemplateResponse'
'480':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'481':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
'482':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'483':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'484':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
parameters:
- name: template-name
in: path
required: true
description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- EmailTemplateRequest
properties:
EmailTemplateRequest:
description: Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
type: object
properties:
DefaultSubstitutions:
allOf:
- $ref: '#/components/schemas/__string'
- description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
HtmlPart:
allOf:
- $ref: '#/components/schemas/__string'
- description: The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
RecommenderId:
allOf:
- $ref: '#/components/schemas/__string'
- description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
Subject:
allOf:
- $ref: '#/components/schemas/__string'
- description: The subject line, or title, to use in email messages that are based on the message template.
tags:
allOf:
- $ref: '#/components/schemas/MapOf__string'
- description: A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription:
allOf:
- $ref: '#/components/schemas/__string'
- description: A custom description of the message template.
TextPart:
allOf:
- $ref: '#/components/schemas/__string'
- description: The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Create Email Template
tags:
- Templates
delete:
operationId: DeleteEmailTemplate
description: Deletes a message template for messages that were sent through the email channel.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteEmailTemplateResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: template-name
in: path
required: true
description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
schema:
type: string
- name: version
in: query
required: false
description: <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
schema:
type: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Delete Email Template
tags:
- Templates
get:
operationId: GetEmailTemplate
description: Retrieves the content and settings of a message template for messages that are sent through the email channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetEmailTemplateResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: template-name
in: path
required: true
description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
schema:
type: string
- name: version
in: query
required: false
description: <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
schema:
type: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Get Email Template
tags:
- Templates
put:
operationId: UpdateEmailTemplate
description: Updates an existing message template for messages that are sent through the email channel.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEmailTemplateResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: create-new-version
in: query
required: false
description: '<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don''t specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don''t specify a value for the version parameter. Otherwise, an error will occur.</p>'
schema:
type: boolean
- name: template-name
in: path
required: true
description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
schema:
type: string
- name: version
in: query
required: false
description: <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- EmailTemplateRequest
properties:
EmailTemplateRequest:
description: Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
type: object
properties:
DefaultSubstitutions:
allOf:
- $ref: '#/components/schemas/__string'
- description: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
HtmlPart:
allOf:
- $ref: '#/components/schemas/__string'
- description: The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
RecommenderId:
allOf:
- $ref: '#/components/schemas/__string'
- description: The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
Subject:
allOf:
- $ref: '#/components/schemas/__string'
- description: The subject line, or title, to use in email messages that are based on the message template.
tags:
allOf:
- $ref: '#/components/schemas/MapOf__string'
- description: A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription:
allOf:
- $ref: '#/components/schemas/__string'
- description: A custom description of the message template.
TextPart:
allOf:
- $ref: '#/components/schemas/__string'
- description: The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Update Email Template
tags:
- Templates
/v1/templates/{template-name}/inapp:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateInAppTemplate
description: Creates a new message template for messages using the in-app message channel.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInAppTemplateResponse'
'480':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'481':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
'482':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'483':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'484':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
parameters:
- name: template-name
in: path
required: true
description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- InAppTemplateRequest
properties:
InAppTemplateRequest:
description: InApp Template Request.
type: object
properties:
Content:
allOf:
- $ref: '#/components/schemas/ListOfInAppMessageContent'
- description: The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
CustomConfig:
allOf:
- $ref: '#/components/schemas/MapOf__string'
- description: Custom config to be sent to client.
Layout:
allOf:
- $ref: '#/components/schemas/Layout'
- description: The layout of the message.
tags:
allOf:
- $ref: '#/components/schemas/MapOf__string'
- description: A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
TemplateDescription:
allOf:
- $ref: '#/components/schemas/__string'
- description: The description of the template.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Create in App Template
tags:
- Templates
delete:
operationId: DeleteInAppTemplate
description: Deletes a message template for messages sent using the in-app message channel.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteInAppTemplateResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: template-name
in: path
required: true
description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
schema:
type: string
- name: version
in: query
required: false
description: <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
schema:
type: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Delete in App Template
tags:
- Templates
get:
operationId: GetInAppTemplate
description: Retrieves the content and settings of a message template for messages sent through the in-app channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetInAppTemplateResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: template-name
in: path
required: true
description: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
schema:
type: string
- name: version
in: query
required: false
description: <p>The unique identifier for the version of the message template to up
# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/openapi/amazon-pinpoint-templates-api-openapi.yml