Contains data that’s returned in response to an asynchronous API request. Responses are retained for 30 days.
Properties
| Name | Data Type | Description |
|---|---|---|
IncludeObjects |
Boolean | When true, the Object property in the response is populated in the result XML. |
IncludeResults |
Boolean | When true, the response includes XML serialized Result objects. When false, the HTTP POST is a basic notification. |
OnlyIncludeBase |
Boolean | When true, the Object property in the response includes only the base API object. |
RespondWhen |
RespondWhen object | Specifies which events cause responses to be sent for the request. |
ResponseAddress |
String | The email address or callback URL to send responses to. |
ResponseType |
AsyncResponseType object | The type of response to send. Accepted values are Email, HTTPPost, and None. |