Amazon Pinpoint · Schema

InAppTemplateRequest

InApp Template Request.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
Content object
CustomConfig object
Layout object
tags object
TemplateDescription object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-in-app-template-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-in-app-template-request-schema.json",
  "title": "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."
        }
      ]
    }
  }
}