RetrieveOptions

Use the RetrieveOptions object in conjunction with a Retrieve call to set the working ClientID for the call.

Properties

NameData TypeDescription
BatchSizexsdNumber of records to return in each batch as part of a Retrieve call.
CallsInConversationxsdRepresents the number of calls that must be received before the conversation support in the asynchronous API begins processing.
ClientClientIDSpecifies the account ownership and context of an object. The ClientID must be a child account of the authenticating parent account.
ConversationIDxsdUnique ID of initial async API call. All requests that are processed as a single unit have the same ConversationID.
IncludeObjectsxsdIndicates 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.
OnlyIncludeBasexsdReduce object to base APIObject information.Includes basic reference data associating object and request.
PriorityxsdDefines the priority for a triggered send. Valid values include Low, Medium, and High.
QueuePriorityPriorityReserved for future use.
RequestTypeRequestTypeDefines request as synchronous or asynchronous API.
SaveOptionsSaveOption[]Allows upsert on selected objects.
ScheduledTimexsdKeeps requests in asynchronous queue until time specified in the call.
SendResponseToAsyncResponse[]Defines how responses are returned and under what conditions. Optional.
SequenceCodexsdSpecifies the processing sequence of a multi-step conversation. This optional property requires the use of ConversationID.