Amazon Pinpoint · JSON Structure

Amazon Pinpoint Message Response Structure

Provides information about the results of a request to send a message to an endpoint address.

Type: object Properties: 4 Required: 1
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

MessageResponse is a JSON Structure definition published by Amazon Pinpoint, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ApplicationId EndpointResult RequestId Result

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-message-response-structure.json",
  "name": "MessageResponse",
  "description": "Provides information about the results of a request to send a message to an endpoint address.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that was used to send the message."
        }
      ]
    },
    "EndpointResult": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfEndpointMessageResult"
        },
        {
          "description": "A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value."
        }
      ]
    },
    "RequestId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The identifier for the original request that the message was delivered for."
        }
      ]
    },
    "Result": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfMessageResult"
        },
        {
          "description": "A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value."
        }
      ]
    }
  },
  "required": [
    "ApplicationId"
  ]
}