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 response includes the API object. |
IncludeResults |
Boolean | When true, the response includes the Result objects. |
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. |