Polling API endpoint

Use the Polling API to find out the status of your async request.

Note: You must send one request for each requestId you want to query. This request does not support sending multiple requestIds per request.

Service URL:

/rest/haAsyncApi/v1.3/requests/{requestId}

NOTE: For this request, ensure that your path uses haAsyncApi instead of haApi. The haAsyncApi part of the path is case sensitive.

Required Path Parameters:

requestId - Unique identifier for the API request. Obtain this value from the successful response to your async request.

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Sample Response:

NOTES:

  • A successful response for the asynchronous API returns an HTTPS status code of 202 Accepted.
  • See Common error responses for the Polling API for details about the error responses.
  • Note that the date and time values consider the Responsys account’s time zone.
{
    "response": [
        {
            "recipientId": 39001321,
            "success": true,
            "errorMessage": null
        },
        {
            "recipientId": 39001501,
            "success": true,
            "errorMessage": null
        }
    ],
    "requestId": "UGpCVnBCOjoxNTQwNTQ2MzQ5",
    "apiName": "HaAsyncMergeTriggerEmail",
    "timeZone": "India Standard Time",
    "requestTime": "2018-10-26T15:02:29.344",
    "requestProcessedTime": "2018-10-26T09:48:18.000",
    "status": "SUCCESS"
}

Learn more

Common error responses for the Polling API