Asynchronous Trigger REI Event
Triggers a REI Event for Profile List, App Channel List, and Web Push recipients. Enables developers to trigger REI events for users across email, print, and mobile app channels to begin Program Orchestration.
REI Events is a feature that needs to be enabled for your account. To access this feature for existing accounts, please log in to My Oracle Support and create a service request.
This endpoint is the asynchronous alternative to Trigger REI Event.
Note: The Asynchronous API is generally available for all Responsys customers.
Service URL:
/rest/asyncApi/v1.3/events/rei/{eventName}
Required Path Parameters:
eventName - Name of the REI event to trigger.
Request Method:
POST
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
For more information about forming a request, see the Trigger REI Event REST Endpoints page in the Oracle Responsys REST API Guide. View the Request section of the topic.
Sample Request Body:
{
"reiEvent": {
"eventNumberDataMapping": null,
"eventDateDataMapping": null,
"eventStringDataMapping": null
},
"recipientData": [
{
"recipient": {
"customerId": null,
"emailAddress": "api.user@oracle.com",
"emailSHA256Hash": null,
"emailMD5Hash": null,
"listName": {
"folderName": "Events",
"objectName": "Summer_Event_Attendees"
},
"recipientId": "",
"mobileNumber": null,
"emailFormat": "HTML_FORMAT"
},
"optionalData": [
{
"name": "DATEFIELD",
"value": "2018-12-13T15:47:00.000+05:30"
},
{
"name": "INTFIELD",
"value": 1
},
{
"name": "NUMFIELD",
"value": 45
},
{
"name": "TEXTFIELD",
"value": "Attendee"
}
]
}
]
}
Response Notes:
- A successful response for the asynchronous API returns an HTTPS status code of 202 Accepted.
- A successful response returns a requestId, to be used in the Polling API endpoint to retrieve the status of your request.
- See Common error responses for the Asynchronous API for details about the error responses.
Sample Response:
{
"requestId": "Z1VzZUxrOjoxNjQzNjA4NTc0",
"apiName": "asyncTriggerReiEvent",
"status": "REQUEST_ACCEPTED",
"links": [
{
"rel": "self",
"href": "/rest/asyncApi/v1.3/events/rei/Summer_Event",
"method": "POST"
},
{
"rel": "asyncResponse",
"href": "/rest/asyncApi/v1.3/requests/Z1VzZUxrOjoxNjQzNjA4NTc0",
"method": "GET"
}
]
}
Sample Error Response - REI event not found
{
"response": {
"errorCode": "REI_EVENT_NOT_FOUND",
"detail": "Unable to retrieve EventDefinition for eventName:Summer_Event for account:70558:apitesting",
"type": "",
"title": "Rei event not found",
"errorDetails": "[]"
},
"requestId": "TkoxdWtBOjoxNjQzNjA4MTEx",
"apiName": "asyncTriggerReiEvent",
"timeZone": "India Standard Time",
"requestTime": "2022-01-31T11:18:31.352",
"requestProcessedTime": "2022-01-31T11:18:31.630",
"status": "ERROR"
}