Update an individual object or batch of objects. In batch requests, you can update multiple data types in one call.
note: Don't use the Update method to create objects. Creating objects using the Update method causes an error.
Parameters
| Name | Data Type | Description |
|---|---|---|
Objects |
Array of APIObject objects | A collection of one or more objects to update. The objects are updated in the order they have been acted upon: first in, first out. This array can hold different object types, which allows you to perform complex interactions, like updating an email, a list, and an email, in one call. |
Options |
UpdateOptions object | Optionally specifies more processing options. An UpdateOptions instance is required for this parameter. However, no properties need to be defined for the instance. |
OverallStatus |
String | Specifies the overall status of the request. Valid status values include:<ul><li>OK - All objects were updated successfully.</li><li>Has Error - When updating multiple APIObject objects, this status means that some of the operations failed, while some succeeded.</li><li>Error - All update operations failed during validation or processing.</li></ul> |
RequestID |
String | A unique identifier for the request. |
Output
- UpdateResult - An array of objects holding a list of return values. The objects are returned in the order acted upon: first in, first out. This array contains one UpdateResult object per input APIObject.