Overview
  • Namespace
  • Class

Namespaces

  • MailChimp
    • AuthorizedApps
    • Automations
    • Batches
    • CampaignFolders
    • Campaigns
    • Conversations
    • Ecommerce
    • FileManager
    • Lists
    • Reports
    • TemplateFolders
    • Templates

Classes

  • Batches

Class Batches

MailChimp\MailChimp
Extended by MailChimp\Batches\Batches
Namespace: MailChimp\Batches
Located at Batches/Batches.php

Methods summary

public object
# getBatches( array $query = [] )

Get a summary of batch requests that have been made.

Get a summary of batch requests that have been made.

Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip.

Parameters

$query
(See Above) OPTIONAL associative array of query parameters.

Returns

object
public object
# getBatch( string $batch_id, array $query = [] )

Get the status of a batch request.

Get the status of a batch request.

Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")

Parameters

$batch_id
$query
(See Above) OPTIONAL associative array of query parameters.

Returns

object
public object
# createBatch( array $data = array(["method" => "", "path" => "", "params" => null, "body"=> null, "operation_id" => null]) )

Begin processing a batch operations request.

Begin processing a batch operations request.

Parameters

$data

Returns

object
public
# deleteBatch( string $batch_id )

Delete a batch request and stop if from processing further.

Delete a batch request and stop if from processing further.

Parameters

$batch_id

Methods inherited from MailChimp\MailChimp

__construct(), authorizedApps(), automations(), batchOps(), campaignFolders(), campaigns(), conversations(), createLog(), ecommerce(), execute(), fileManager(), fileManagerFolders(), getAccountInfo(), getMemberHash(), lists(), logData(), optionalFields(), reports(), searchMembers(), templateFolders(), templates()

API documentation generated by ApiGen