Use the RetrieveOptions object in conjunction with a Retrieve call to set the working ClientID for the call.
Properties
| Name | Data Type | Description |
|---|---|---|
BatchSize |
Integer | Number of records to return in each batch as part of a Retrieve call. |
CallsInConversation |
Integer | Represents the number of calls that must be received before the conversation support in the asynchronous API begins processing. |
Client |
ClientID | Specifies the account ownership and context of an object. The ClientID must be a child account of the authenticating parent account. |
ConversationID |
String | Unique ID of initial async API call. All requests that are processed as a single unit have the same ConversationID. |
IncludeObjects |
Boolean | Indicates whether the APIObject is included in the response. If you are only interested in the Result object and want to reduce the size of the response message, set this property to True. |
OnlyIncludeBase |
Boolean | Reduce object to base APIObject information.Includes basic reference data associating object and request. |
Priority |
String | Defines the priority for a triggered send. Valid values include Low, Medium, and High. |
QueuePriority |
Priority | Defines the priority for asynchronous sends. Accepted values are High, Medium, and Low. The default value is Medium. |
RequestExpirationTime |
String | The date and time when the asynchronous API request expires. Specify the value in ISO 8601 format with UTC time or with a timezone offset. When you specify both RequestExpirationTime and ScheduledTime in a request, the RequestExpirationTime must occur after the ScheduledTime. |
RequestType |
RequestType | The type of request. Possible values are synchronous and asynchronous. |
SaveOptions |
Array of SaveOption objects | Specifies how information is overwritten. |
ScheduledTime |
String | The date and time at which the request must be processed. Specify the value in ISO 8601 format with UTC time or a timezone offset. The specified time can be up to 30 days in the future. |
SendResponseTo |
Array AsyncResponse objects | Defines how responses are returned and under what conditions. Optional. |
SequenceCode |
Integer | Specifies the processing sequence of a multi-step conversation. This optional property requires the use of ConversationID. |