Options

The Options object is the base object for all options on methods, such as Create. To avoid having to specify ClientID on all objects within the call, specify ClientID on this object.

Properties

NameData TypeDescription
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.
ConversationIDxsdUnique ID of initial async API call. All requests that are processed as a single unit have the same ConversationID.
PriorityxsdDefines the priority for a triggered send. Valid values include Low, Medium, and High.
QueuePriorityPrioritySpecifies the priority of the triggered send.
RequestTypeRequestTypeDefines request as synchronous or asynchronous API.
SaveOptionsSaveOption[]Allows upsert on selected objects.
ScheduledTimexsdKeeps requests in asynchronous queue until time specified in the call.
To maintain compliance with data privacy regulations, avoid scheduling tasks in the future. Scheduling async tasks in the future can reintroduce deleted or restricted contacts into the system.
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.