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 accepts any 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.

This method has the following parameters.

NameData TypeDescription
RequestIDStringA unique identifier for the request. This parameter requires a null RequestId string. By default, this value is a GUID.
RequestsExecuteRequestAn 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.
ResultsExecuteResponse[]The results of a method execution returned as an output parameter.
  • GetFolderHierarchy - This method retrieves the email folder hierarchy for an account.
  • MasterUnsub - Deprecated: Use the Subscriber Object to unsubscribe a subscriber.
NameData TypeDescription
ExecuteResponsearrayThis output contains an array of objects holding a list of return values. The objects are returned in the order they are executed. This array contains one ExecuteResponse object per input ExecuteRequest.
OverallStatusStringA string value containing the overall status of the request. Valid status values include:
  • OK - All requests were successfully executed.
  • Has Error - When executing multiple APIObject requests, this status code states that some of the operations failed, while some succeeded.
  • Error - All execute operations failed during validation or processing.