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

NameData TypeDescription
BatchSizeIntegerNumber of records to return in each batch as part of a Retrieve call.
CallsInConversationIntegerRepresents 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.
ConversationIDStringUnique ID of initial async API call. All requests that are processed as a single unit have the same ConversationID.
IncludeObjectsBooleanIndicates 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.
OnlyIncludeBaseBooleanReduce object to base APIObject information.Includes basic reference data associating object and request.
PriorityStringDefines the priority for a triggered send. Valid values include Low, Medium, and High.
QueuePriorityPriorityDefines the priority for asynchronous sends. Accepted values are High, Medium, and Low. The default value is Medium.
RequestExpirationTimeStringThe 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.
RequestTypeRequestTypeThe type of request. Possible values are synchronous and asynchronous.
SaveOptionsArray of SaveOption objectsSpecifies how information is overwritten.
ScheduledTimeStringThe 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.
SendResponseToArray AsyncResponse objectsDefines how responses are returned and under what conditions. Optional.
SequenceCodeIntegerSpecifies the processing sequence of a multi-step conversation. This optional property requires the use of ConversationID.