AsyncResponse

Use the AsyncResponse object to modify return of data sent in response to asynchronous API request. The object is available for 30 days after initial response. If you are interested in only the Result object and want to reduce the size of the response message, set the IncludeObjects property value to True.

Properties

NameData TypeDescription
IncludeObjectsxsdIndicates whether the APIObject is included in the response.
IncludeResultsxsdDetermines whether the Result objects are included in the response when an asynchronous API call completes processing.
OnlyIncludeBasexsdReduce object to base APIObject information. Includes basic reference data associating object and request.
RespondWhenRespondWhenSpecifies event triggers the AsyncResponse object action.
ResponseAddressxsdEmail address or public URL to receive POST response to asynchronous request.
ResponseTypeAsyncResponseTypeSpecifies type of response associated with an asynchronous operation.

Sample Respond When SOAP Request

Asynchronous Processing