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.
| Name | Data Type | Description |
|---|---|---|
Action | String | Defines the action to take for the specified object. Valid values are CREATE, DELETE, and UPDATE. |
CallsInConversation | Integer | Indicates 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. |
Client | ClientID | Specifies the account ownership and context of an object. |
Container | ContainerID | A common base type that other types within the API are inherited from. |
ConversationID | String | A 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. |
Priority | String | This property is deprecated. The API accepts requests that contain this property, but we recommend that you use the QueuePriority property in new API calls. |
QueuePriority | Priority | Defines the priority for asynchronous sends. Accepted values: 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 of 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. |