MessageRequest is a JSON Structure definition published by Amazon Pinpoint, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$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-request-structure.json",
"name": "MessageRequest",
"description": "Specifies the configuration and other settings for a message.",
"type": "object",
"properties": {
"Addresses": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfAddressConfiguration"
},
{
"description": "A map of key-value pairs, where each key is an address and each value is an <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration\">AddressConfiguration</a> object. An address can be a push notification token, a phone number, or an email address. You can use an <a href=\"https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration\">AddressConfiguration</a> object to tailor the message for an address by specifying settings such as content overrides and message variables."
}
]
},
"Context": {
"allOf": [
{
"$ref": "#/components/schemas/MapOf__string"
},
{
"description": "A map of custom attributes to attach to the message. 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."
}
]
},
"Endpoints": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfEndpointSendConfiguration"
},
{
"description": "A map of key-value pairs, where each key is an endpoint ID and each value is 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. 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 an endpoint by specifying settings such as content overrides and message variables."
}
]
},
"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."
}
]
}
},
"required": [
"MessageConfiguration"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.