UpdateOptions

The UpdateOptions object defines the ability to save, update, or delete data extension fields using a container. If the Container property contains an instance of DataExtensionField, and the value of the Action property is DELETE, the call drops any child fields. Otherwise, the call adds or updates all child fields depending upon whether they exist.

NameData TypeDescription
ActionStringDefines the action to take for the specified object. Valid values are CREATE, DELETE, and UPDATE.
CallsInConversationIntegerIndicates the number of calls that are part of a conversation. Processing of the conversation begins when the specified number of calls has been received. This is an optional property. When you specify this property, you must also specify the ConversationID property.
ClientClientIDSpecifies the account ownership and context of an object.
ContainerContainerIDA common base type that other types within the API are inherited from.
ConversationIDStringA unique ID for grouping multiple calls into a single conversation. All calls with the same ConversationID are processed as a single unit. This is an optional property.
PriorityStringThis property is deprecated. The API accepts requests that contain this property, but we recommend that you use the QueuePriority property in new API calls.
QueuePriorityPriorityDefines the priority for asynchronous sends. Accepted values: 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 of 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.