Amazon Pinpoint · JSON Structure

Amazon Pinpoint Send Users Message Request Structure

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

Type: object Properties: 5 Required: 2
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

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

Properties

Context MessageConfiguration TemplateConfiguration TraceId Users

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-request-structure.json",
  "name": "SendUsersMessageRequest",
  "description": "Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.",
  "type": "object",
  "properties": {
    "Context": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOf__string"
        },
        {
          "description": "A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries."
        }
      ]
    },
    "MessageConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DirectMessageConfiguration"
        },
        {
          "description": "The settings and content for the default message and any default messages that you defined for specific channels."
        }
      ]
    },
    "TemplateConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TemplateConfiguration"
        },
        {
          "description": "The message template to use for the message."
        }
      ]
    },
    "TraceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for tracing the message. This identifier is visible to message recipients."
        }
      ]
    },
    "Users": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfEndpointSendConfiguration"
        },
        {
          "description": "A map that associates user IDs with <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration\">EndpointSendConfiguration</a> objects. You can use an <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration\">EndpointSendConfiguration</a> object to tailor the message for a user by specifying settings such as content overrides and message variables."
        }
      ]
    }
  },
  "required": [
    "MessageConfiguration",
    "Users"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/amazon-pinpoint-send-users-message-request-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.