Amazon Pinpoint · Schema

EndpointSendConfiguration

Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
BodyOverride object
Context object
RawContent object
Substitutions object
TitleOverride object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-endpoint-send-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-endpoint-send-configuration-schema.json",
  "title": "EndpointSendConfiguration",
  "description": "Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.",
  "type": "object",
  "properties": {
    "BodyOverride": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The body of the message. If specified, this value overrides the default message body."
        }
      ]
    },
    "Context": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOf__string"
        },
        {
          "description": "<p>A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.</p> <p>For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>"
        }
      ]
    },
    "RawContent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message."
        }
      ]
    },
    "Substitutions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfListOf__string"
        },
        {
          "description": "A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables."
        }
      ]
    },
    "TitleOverride": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The title or subject line of the message. If specified, this value overrides the default message title or subject line."
        }
      ]
    }
  }
}