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-inapp-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 Inapp 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: Inapp
paths:
  /v1/templates/{TemplateName}/inapp:
    post:
      operationId: CreateInAppTemplate
      summary: Create In App Template
      description: Creates a new message template for messages using the in-app message channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInAppTemplateResponse'
        '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/CreateInAppTemplateRequest'
      tags:
      - Inapp
    delete:
      operationId: DeleteInAppTemplate
      summary: Delete In App Template
      description: Deletes a message template for messages sent using the in-app message channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInAppTemplateResponse'
        '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/DeleteInAppTemplateRequest'
      tags:
      - Inapp
    get:
      operationId: GetInAppTemplate
      summary: Get In App Template
      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'
        '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/GetInAppTemplateRequest'
      tags:
      - Inapp
    put:
      operationId: UpdateInAppTemplate
      summary: Update In App Template
      description: Updates an existing message template for messages sent through the in-app message channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateInAppTemplateResponse'
        '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/UpdateInAppTemplateRequest'
      tags:
      - Inapp
components:
  schemas:
    InAppMessageBodyConfig:
      type: object
      properties:
        Alignment:
          type: string
          enum:
          - LEFT
          - CENTER
          - RIGHT
          description: 'The alignment of the text. Valid values: LEFT, CENTER, RIGHT.'
        Body:
          type: string
          description: Message Body.
        TextColor:
          type: string
          description: The text color.
      required:
      - Alignment
      - Body
      - TextColor
    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.
    TemplateCreateMessageBody:
      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.
    DeleteInAppTemplateResponse:
      type: object
      properties:
        MessageBody:
          $ref: '#/components/schemas/MessageBody'
      required:
      - MessageBody
    InAppTemplateRequest:
      type: object
      properties:
        Content:
          type: array
          items:
            $ref: '#/components/schemas/InAppMessageContent'
          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:
          type: object
          additionalProperties:
            type: string
          description: Custom config to be sent to client.
        Layout:
          type: string
          enum:
          - BOTTOM_BANNER
          - TOP_BANNER
          - OVERLAYS
          - MOBILE_FEED
          - MIDDLE_BANNER
          - CAROUSEL
          description: The layout of the message.
        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: The description of the template.
    DeleteInAppTemplateRequest:
      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
    GetInAppTemplateResponse:
      type: object
      properties:
        InAppTemplateResponse:
          $ref: '#/components/schemas/InAppTemplateResponse'
      required:
      - InAppTemplateResponse
    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.
    UpdateInAppTemplateRequest:
      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.'
        InAppTemplateRequest:
          $ref: '#/components/schemas/InAppTemplateRequest'
        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:
      - InAppTemplateRequest
      - TemplateName
    InAppTemplateResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The resource arn of the template.
        Content:
          type: array
          items:
            $ref: '#/components/schemas/InAppMessageContent'
          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.
        CreationDate:
          type: string
          description: The creation date of the template.
        CustomConfig:
          type: object
          additionalProperties:
            type: string
          description: Custom config to be sent to client.
        LastModifiedDate:
          type: string
          description: The last modified date of the template.
        Layout:
          type: string
          enum:
          - BOTTOM_BANNER
          - TOP_BANNER
          - OVERLAYS
          - MOBILE_FEED
          - MIDDLE_BANNER
          - CAROUSEL
          description: The layout of the message.
        tags:
          type: object
          additionalProperties:
            type: 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:
          type: string
          description: The description of the template.
        TemplateName:
          type: string
          description: The name of the template.
        TemplateType:
          type: string
          enum:
          - EMAIL
          - SMS
          - VOICE
          - PUSH
          - INAPP
          description: The type of the template.
        Version:
          type: string
          description: The version id of the template.
      required:
      - CreationDate
      - LastModifiedDate
      - TemplateName
      - TemplateType
    CreateInAppTemplateRequest:
      type: object
      properties:
        InAppTemplateRequest:
          $ref: '#/components/schemas/InAppTemplateRequest'
        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:
      - InAppTemplateRequest
      - TemplateName
    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.
    GetInAppTemplateRequest:
      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
    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.
    InAppMessageHeaderConfig:
      type: object
      properties:
        Alignment:
          type: string
          enum:
          - LEFT
          - CENTER
          - RIGHT
          description: 'The alignment of the text. Valid values: LEFT, CENTER, RIGHT.'
        Header:
          type: string
          description: Message Header.
        TextColor:
          type: string
          description: The text color.
      required:
      - Alignment
      - Header
      - TextColor
    UpdateInAppTemplateResponse:
      type: object
      properties:
        MessageBody:
          $ref: '#/components/schemas/MessageBody'
      required:
      - MessageBody
    InAppMessageContent:
      type: object
      properties:
        BackgroundColor:
          type: string
          description: The background color for the message.
        BodyConfig:
          $ref: '#/components/schemas/InAppMessageBodyConfig'
        HeaderConfig:
          $ref: '#/components/schemas/InAppMessageHeaderConfig'
        ImageUrl:
          type: string
          description: The image url for the background of message.
        PrimaryBtn:
          $ref: '#/components/schemas/InAppMessageButton'
        SecondaryBtn:
          $ref: '#/components/schemas/InAppMessageButton'
    CreateInAppTemplateResponse:
      type: object
      properties:
        TemplateCreateMessageBody:
          $ref: '#/components/schemas/TemplateCreateMessageBody'
      required:
      - TemplateCreateMessageBody
    OverrideButtonConfiguration:
      type: object
      properties:
        ButtonAction:
          type: string
          enum:
          - LINK
          - DEEP_LINK
          - CLOSE
          description: Action triggered by the button.
        Link:
          type: string
          description: Button destination.
      required:
      - ButtonAction
    DefaultButtonConfiguration:
      type: object
      properties:
        BackgroundColor:
          type: string
          description: The background color of the button.
        BorderRadius:
          type: integer
          description: The border radius of the button.
        ButtonAction:
          type: string
          enum:
          - LINK
          - DEEP_LINK
          - CLOSE
          description: Action triggered by the button.
        Link:
          type: string
          description: Button destination.
        Text:
          type: string
          description: Button text.
        TextColor:
          type: string
          description: The text color of the button.
      required:
      - ButtonAction
      - Text
    InAppMessageButton:
      type: object
      properties:
        Android:
          $ref: '#/components/schemas/OverrideButtonConfiguration'
        DefaultConfig:
          $ref: '#/components/schemas/DefaultButtonConfiguration'
        IOS:
          $ref: '#/components/schemas/OverrideButtonConfiguration'
        Web:
          $ref: '#/components/schemas/OverrideButtonConfiguration'
    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.
    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.
    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.
  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)