MOmoengage
Transactional Alerts

Send Transactional Alert

This API is used to trigger a transactional message/alert to the user via one or more configured channels.

post/alerts/send

Request

Request body

alert_idstring

This field uniquely identifies the Alert to be sent to the user. For the staging endpoint, use the test alert id and for the live endpoint, use the alert id. For more information, refer to Live and Test Alerts.

alert_reference_namestring

This field is used to identify the Alert using your reference Name and can be used to identify the alert as an alternative to Alert ID.

user_idstring

This is the unique user identifier information you maintain. This information should be passed in the request to facilitate the mapping of the channel events back to the user profile to which this user_id is associated in MoEngage.

transaction_idstring required

This is the unique identifier denoting the transaction for which the Alert is being sent to the user. This information is maintained by the brand and is passed in the request. The maximum length allowed for this field is 50 characters.

The Inform API supports idempotency using this parameter. If a request contains a transaction_id and is successful and another request with the same transaction_id is received within 5 minutes of the successful request, the new request would be deemed a duplicate one.

Response

Request has been received and processed. The response body contains the status for the overall request and for each individual channel.

Note: Reach out to your Customer Success Manager to enable sending the channel level details as part of your API response.

messagestring
request_idstring

Example response

{
  "message": "Successfully Received"
}

Changes

No recorded changes to this operation across all 1 revision of this API.