Use the Execute method to get access to and execute individual or batches of helper requests. The helper functions provide access to functionality that would be tedious to build using other methods. Requests execute in the order they are added to the ExecuteRequest array.
An ExecuteRequest object accepts an unlimited number of request parameters. Each request type has a set number of request parameters that are required to make the request work or to configure the request.
Parameters
This method has the following parameters.
| Name | Data Type | Description |
|---|---|---|
RequestID |
String | A unique identifier for the request. This parameter requires a null RequestId string. By default, this value is a GUID. |
Requests |
ExecuteRequest object | An array of ExecuteRequest objects that specify the execution properties for a method. The objects are acted on in the order they have been added. This array can hold different ExecuteRequest types, which allows you to execute complex interactions in one call. |
Results |
Array of ExecuteResponse objects | The results of a method execution returned as an output parameter. |
Request Types
- GetFolderHierarchy - This method retrieves the email folder hierarchy for an account.
- MasterUnsub - Deprecated: Use the Subscriber Object to unsubscribe a subscriber.
Output
| Name | Data Type | Description |
|---|---|---|
[ExecuteResponse](executeresponse.md) |
Array | An array of objects that contains a list of return values. The objects are returned in the order they’re executed. This array contains one ExecuteResponse object for ExecuteRequest object in the request. |
OverallStatus |
String | The overall status of the request. Valid status values include:<ul><li>OK - All requests were successfully executed.</li><li>Has Error - When executing multiple APIObject requests, this status code states that some of the operations failed, while some succeeded.</li><li>Error - All execute operations failed during validation or processing.</li></ul> |