batches - marcocusano/mailchimp-php GitHub Wiki

Use batch operations to complete multiple operations with a single call.

create

Begin processing a batch operations request.

$params = array(
    "operations" => {
        "method" => "GET/POST/PATCH",
        "path" => "The relative path to use for the operation.",
        "params" => array(),
        "body" => "A string containing the JSON body to use with the request.",
        "operation_id" => "An optional client-supplied id returned with the operation results."
    }
);
$mailchimp->batches->createOperation($params);

delete

Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call.

$mailchimp->batches->deleteOperation("BATCH_ID");

get

Get a summary of batch requests that have been made: Get a list of batch requests or get the status of a batch operation request.

// Specify BATCH_ID only if you are looking for a specific operation. Without you will receive a list of batch reuqests.
$mailchimp->getOperations("BATCH_ID")
⚠️ **GitHub.com Fallback** ⚠️