AsyncResponse
Use the AsyncResponse object to modify the data that is returned in response to an asynchronous API request. The object is available for 30 days after initial response. If you want to retrieve the Result object and also want to reduce the size of the response message, set the value of IncludeObjects to true.
| Name | Data Type | Description |
|---|---|---|
IncludeObjects | Boolean | When true, the API object is included in the response. |
IncludeResults | Boolean | When true, the Result objects are included in the response. |
OnlyIncludeBase | Boolean | When true, the response object contains only the base API object information. Includes basic reference data associating object and request. |
RespondWhen | RespondWhen object | Specifies which events cause responses to be sent for the request. |
ResponseAddress | String | The email address or public URL to send responses to. |
ResponseType | AsyncResponseType object | The type of response associated with an asynchronous operation. |