Amazon Pinpoint · Schema

TemplateConfiguration

Specifies the message template to use for the message, for each type of channel.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
EmailTemplate object
PushTemplate object
SMSTemplate object
VoiceTemplate object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-template-configuration-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-template-configuration-schema.json",
  "title": "TemplateConfiguration",
  "description": "Specifies the message template to use for the message, for each type of channel.",
  "type": "object",
  "properties": {
    "EmailTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Template"
        },
        {
          "description": "The email template to use for the message."
        }
      ]
    },
    "PushTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Template"
        },
        {
          "description": "The push notification template to use for the message."
        }
      ]
    },
    "SMSTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Template"
        },
        {
          "description": "The SMS template to use for the message."
        }
      ]
    },
    "VoiceTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Template"
        },
        {
          "description": "The voice template to use for the message. This object isn't supported for campaigns."
        }
      ]
    }
  }
}