Amazon Pinpoint · JSON Structure

Amazon Pinpoint In App Message Content Structure

The configuration for the message content.

Type: object Properties: 6
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

InAppMessageContent is a JSON Structure definition published by Amazon Pinpoint, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

BackgroundColor BodyConfig HeaderConfig ImageUrl PrimaryBtn SecondaryBtn

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-in-app-message-content-structure.json",
  "name": "InAppMessageContent",
  "description": "The configuration for the message content.",
  "type": "object",
  "properties": {
    "BackgroundColor": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The background color for the message."
        }
      ]
    },
    "BodyConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppMessageBodyConfig"
        },
        {
          "description": "The configuration for the message body."
        }
      ]
    },
    "HeaderConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppMessageHeaderConfig"
        },
        {
          "description": "The configuration for the message header."
        }
      ]
    },
    "ImageUrl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The image url for the background of message."
        }
      ]
    },
    "PrimaryBtn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppMessageButton"
        },
        {
          "description": "The first button inside the message."
        }
      ]
    },
    "SecondaryBtn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InAppMessageButton"
        },
        {
          "description": "The second button inside message."
        }
      ]
    }
  }
}