Amazon Pinpoint · JSON Structure

Amazon Pinpoint Send Users Message Response Structure

Provides information about which users and endpoints a message was sent to.

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

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

Properties

ApplicationId 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-send-users-message-response-structure.json",
  "name": "SendUsersMessageResponse",
  "description": "Provides information about which users and endpoints a message was sent to.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that was used to send the message."
        }
      ]
    },
    "RequestId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier that was assigned to the message request."
        }
      ]
    },
    "Result": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfMapOfEndpointMessageResult"
        },
        {
          "description": "An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object."
        }
      ]
    }
  },
  "required": [
    "ApplicationId"
  ]
}