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-push-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Amazon Pinpoint Push API
  version: '2016-12-01'
  description: Generated from AWS's published Smithy model for Amazon Pinpoint. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://pinpoint.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Push
paths:
  /v1/templates/{TemplateName}/push:
    post:
      operationId: CreatePushTemplate
      summary: Create Push Template
      description: Creates a message template for messages that are sent through a push notification channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePushTemplateResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePushTemplateRequest'
      tags:
      - Push
    delete:
      operationId: DeletePushTemplate
      summary: Delete Push Template
      description: Deletes a message template for messages that were sent through a push notification channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePushTemplateResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeletePushTemplateRequest'
      tags:
      - Push
    get:
      operationId: GetPushTemplate
      summary: Get Push Template
      description: Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPushTemplateResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPushTemplateRequest'
      tags:
      - Push
    put:
      operationId: UpdatePushTemplate
      summary: Update Push Template
      description: Updates an existing message template for messages that are sent through a push notification channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePushTemplateResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePushTemplateRequest'
      tags:
      - Push
components:
  schemas:
    GetPushTemplateRequest:
      type: object
      properties:
        TemplateName:
          type: string
          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.
        Version:
          type: string
          description: '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 Template Versions resource. 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. If you don''t specify a value for this parameter, Amazon Pinpoint does the following: For a get op'
      required:
      - TemplateName
    DefaultPushNotificationTemplate:
      type: object
      properties:
        Action:
          type: string
          enum:
          - OPEN_APP
          - DEEP_LINK
          - URL
          description: 'The action to occur if a recipient taps a push notification that''s based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. URL - The default mobile browser on the recipient''s device opens and loads the web page at a URL that you specify.'
        Body:
          type: string
          description: The message body to use in push notifications that are based on the message template.
        Sound:
          type: string
          description: The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
        Title:
          type: string
          description: The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
        Url:
          type: string
          description: The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    DeletePushTemplateResponse:
      type: object
      properties:
        MessageBody:
          $ref: '#/components/schemas/MessageBody'
      required:
      - MessageBody
    CreateTemplateMessageBody:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the message template that was created.
        Message:
          type: string
          description: The message that's returned from the API for the request to create the message template.
        RequestID:
          type: string
          description: The unique identifier for the request to create the message template.
    UpdatePushTemplateRequest:
      type: object
      properties:
        CreateNewVersion:
          type: boolean
          description: '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. 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.'
        PushNotificationTemplateRequest:
          $ref: '#/components/schemas/PushNotificationTemplateRequest'
        TemplateName:
          type: string
          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.
        Version:
          type: string
          description: '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 Template Versions resource. 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. If you don''t specify a value for this parameter, Amazon Pinpoint does the following: For a get op'
      required:
      - PushNotificationTemplateRequest
      - TemplateName
    UpdatePushTemplateResponse:
      type: object
      properties:
        MessageBody:
          $ref: '#/components/schemas/MessageBody'
      required:
      - MessageBody
    MessageBody:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    PayloadTooLargeException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    CreatePushTemplateResponse:
      type: object
      properties:
        CreateTemplateMessageBody:
          $ref: '#/components/schemas/CreateTemplateMessageBody'
      required:
      - CreateTemplateMessageBody
    CreatePushTemplateRequest:
      type: object
      properties:
        PushNotificationTemplateRequest:
          $ref: '#/components/schemas/PushNotificationTemplateRequest'
        TemplateName:
          type: string
          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.
      required:
      - PushNotificationTemplateRequest
      - TemplateName
    MethodNotAllowedException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    AndroidPushNotificationTemplate:
      type: object
      properties:
        Action:
          type: string
          enum:
          - OPEN_APP
          - DEEP_LINK
          - URL
          description: 'The action to occur if a recipient taps a push notification that''s based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient''s device opens and loads the web page at a URL that you specify.'
        Body:
          type: string
          description: The message body to use in a push notification that's based on the message template.
        ImageIconUrl:
          type: string
          description: The URL of the large icon image to display in the content view of a push notification that's based on the message template.
        ImageUrl:
          type: string
          description: The URL of an image to display in a push notification that's based on the message template.
        RawContent:
          type: string
          description: The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
        SmallImageIconUrl:
          type: string
          description: The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
        Sound:
          type: string
          description: The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
        Title:
          type: string
          description: The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
        Url:
          type: string
          description: The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
    PushNotificationTemplateRequest:
      type: object
      properties:
        ADM:
          $ref: '#/components/schemas/AndroidPushNotificationTemplate'
        APNS:
          $ref: '#/components/schemas/APNSPushNotificationTemplate'
        Baidu:
          $ref: '#/components/schemas/AndroidPushNotificationTemplate'
        Default:
          $ref: '#/components/schemas/DefaultPushNotificationTemplate'
        DefaultSubstitutions:
          type: 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.
        GCM:
          $ref: '#/components/schemas/AndroidPushNotificationTemplate'
        RecommenderId:
          type: 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.
        tags:
          type: object
          additionalProperties:
            type: string
          description: As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK. (Deprecated) 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:
          type: string
          description: A custom description of the message template.
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    GetPushTemplateResponse:
      type: object
      properties:
        PushNotificationTemplateResponse:
          $ref: '#/components/schemas/PushNotificationTemplateResponse'
      required:
      - PushNotificationTemplateResponse
    APNSPushNotificationTemplate:
      type: object
      properties:
        Action:
          type: string
          enum:
          - OPEN_APP
          - DEEP_LINK
          - URL
          description: 'The action to occur if a recipient taps a push notification that''s based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient''s device opens and loads the web page at a URL that you specify.'
        Body:
          type: string
          description: The message body to use in push notifications that are based on the message template.
        MediaUrl:
          type: string
          description: The URL of an image or video to display in push notifications that are based on the message template.
        RawContent:
          type: string
          description: The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
        Sound:
          type: string
          description: The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
        Title:
          type: string
          description: The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
        Url:
          type: string
          description: The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    DeletePushTemplateRequest:
      type: object
      properties:
        TemplateName:
          type: string
          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.
        Version:
          type: string
          description: '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 Template Versions resource. 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. If you don''t specify a value for this parameter, Amazon Pinpoint does the following: For a get op'
      required:
      - TemplateName
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    PushNotificationTemplateResponse:
      type: object
      properties:
        ADM:
          $ref: '#/components/schemas/AndroidPushNotificationTemplate'
        APNS:
          $ref: '#/components/schemas/APNSPushNotificationTemplate'
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the message template.
        Baidu:
          $ref: '#/components/schemas/AndroidPushNotificationTemplate'
        CreationDate:
          type: string
          description: The date, in ISO 8601 format, when the message template was created.
        Default:
          $ref: '#/components/schemas/DefaultPushNotificationTemplate'
        DefaultSubstitutions:
          type: string
          description: The JSON object that specifies the default values that are used 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.
        GCM:
          $ref: '#/components/schemas/AndroidPushNotificationTemplate'
        LastModifiedDate:
          type: string
          description: The date, in ISO 8601 format, when the message template was last modified.
        RecommenderId:
          type: string
          description: The unique identifier for the recommender model that's used by the message template.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
        TemplateDescription:
          type: string
          description: The custom description of the message template.
        TemplateName:
          type: string
          description: The name of the message template.
        TemplateType:
          type: string
          enum:
          - EMAIL
          - SMS
          - VOICE
          - PUSH
          - INAPP
          description: The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
        Version:
          type: string
          description: The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
      required:
      - CreationDate
      - LastModifiedDate
      - TemplateName
      - TemplateType
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: mobiletargeting
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/pinpoint/service/2016-12-01/pinpoint-2016-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)