POST
/v1/apps/{application-id}/users-messages
http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/users-messagesCreates and sends a message to a list of users.
Access Token Required: API Key
Path Parameters
application-idstringrequired
The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.
Body Params
SendUsersMessageRequestobjectrequired
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/users-messages' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}