Mailchimp Marketing PHP SDK

To get started, ensure you are using PHP 7.2 or above. Initialize the ApiClient, configure it with your credentials, and make a test call using the ping endpoint.

Note that you must provide a server prefix (e.g., us19) so the client can determine the correct host URL.

require_once('/path/to/MailchimpMarketing/vendor/autoload.php');

$mailchimp = new MailchimpMarketing\ApiClient();

$mailchimp->setConfig([
  'apiKey' => 'YOUR_API_KEY',
  'server' => 'YOUR_SERVER_PREFIX'
]);

$response = $mailchimp->ping->get();
print_r($response);

You can install the SDK using Composer via Packagist, which is the recommended method, or by cloning the repository manually.

Using Composer

Run the following command in your terminal:

composer require mailchimp/marketing

Alternatively, add this to your composer.json file:

{
  "require": {
    "mailchimp/marketing": "*"
  }
}

Then run composer install to install dependencies.

Manual Installation

1. Clone the repository:

git clone git@github.com:mailchimp/mailchimp-marketing-php.git

2. Install dependencies in the project root:

composer install

3. Manually include the autoloader in your project:

require_once('/path/to/MailchimpMarketing/vendor/autoload.php');

For most methods in AutomationsApi, there is a corresponding WithHttpInfo version (e.g., pauseWorkflowEmailWithHttpInfo). Use these when you need access to the full HTTP response metadata or need to catch and inspect ApiException objects specifically.

Example pattern:

• pauseWorkflowEmail($id, $email_id): Returns the decoded JSON response body directly.
• pauseWorkflowEmailWithHttpInfo($id, $email_id): Returns the decoded JSON response body but allows for more granular error handling via ApiException.

The ApiClient supports two authentication methods. For both methods, you must include the server key (e.g., us19) in the configuration array.

Basic Auth

Use your Mailchimp API Key:

$mailchimp->setConfig([
  'apiKey' => 'YOUR_API_KEY',
  'server' => 'YOUR_SERVER_PREFIX'
]);

OAuth2

Use your OAuth2 Access Token:

$mailchimp->setConfig([
  'accessToken' => 'YOUR_ACCESS_TOKEN',
  'server' => 'YOUR_SERVER_PREFIX'
]);

// Basic Auth Example
$mailchimp->setConfig([
  'apiKey' => 'YOUR_API_KEY',
  'server' => 'YOUR_SERVER_PREFIX'
]);

// OAuth2 Example
$mailchimp->setConfig([
  'accessToken' => 'YOUR_ACCESS_TOKEN',
  'server' => 'YOUR_SERVER_PREFIX'
]);

When an API request fails, the SDK throws a MailchimpMarketing\ApiException. This exception contains detailed information about the failed HTTP request, allowing you to inspect the error response from Mailchimp's servers.

You can catch this exception to retrieve the HTTP status code, the response headers, and the response body (which is typically a JSON object containing error details).

try {
    // Your Mailchimp API call here
} catch (\MailchimpMarketing\ApiException $e) {
    echo 'Error Message: ' . $e->getMessage() . PHP_EOL;
    echo 'HTTP Status Code: ' . $e->getCode() . PHP_EOL;
    
    // Get the decoded JSON body containing error details
    $errorBody = $e->getResponseBody();
    print_r($errorBody);

    // Get response headers if needed
    $headers = $e->getResponseHeaders();
}

The SDK uses ApiException to signal errors returned by the Mailchimp API. When an API request fails (status code outside the 200-299 range), an ApiException is thrown.

To access the detailed error response provided by Mailchimp (which often contains specific error messages and codes in JSON format), you should catch the ApiException and call getResponseBody() on it.

Example:

try {
    $response = $campaignsApi->update($campaign_id, $body);
} catch (ApiException $e) {
    // The response body contains the parsed JSON error from Mailchimp
    $errorDetails = $e->getResponseBody();
    print_r($errorDetails);
}

Create a new marketing campaign using a POST request.

Parameters:

• body (required): An object or array containing the campaign configuration and details.

$response = $campaignsApi->create($body);

Retrieve details for a specific email within an automation workflow using the getWorkflowEmail method.

$automationsApi->getWorkflowEmail($workflow_id, $workflow_email_id);

Use the archive method to archive an existing automation workflow by its ID. This performs a POST request to the /automations/{workflow_id}/actions/archive endpoint.

$automationsApi->archive($workflow_id);

Delete a specific campaign folder using its unique identifier.

$apiInstance = new MailchimpMarketing\Api\CampaignFoldersApi($configuration);
$folderId = 'folder_id_here';
$apiInstance->remove($folderId);