PHP code example of xdubois / activecampaign-api

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

xdubois / activecampaign-api example snippets

use xdubois\ActiveCampaign\ActiveCampaignAPI;

$api = new ActiveCampaignAPI('your-api-key', 'https://youraccount.api-us1.com');

use xdubois\ActiveCampaign\ActiveCampaignAPI;
use xdubois\ActiveCampaign\Configuration;

$config = new Configuration(
    'your-api-key',
    'https://youraccount.api-us1.com',
    timeout: 60,           // Total request timeout in seconds
    connectTimeout: 10,    // Connection timeout in seconds
    maxRetries: 3,         // Retries for 429 / 5xx / network errors
    retryDelay: 1.0,       // Base delay in seconds, doubled after each retry (Retry-After wins when present)
    defaultHeaders: ['User-Agent' => 'my-app/1.0'],
);

$api = new ActiveCampaignAPI($config);

use GuzzleHttp\Client;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Psr7\Response;

$mock = new MockHandler([new Response(200, [], '{"contact": {"id": "1"}}')]);
$client = new Client(['handler' => HandlerStack::create($mock)]);

$api = new ActiveCampaignAPI($config, null, $client);
$api->contacts()->get(1); // => ['contact' => ['id' => '1']]

// Create a contact
$contact = $api->contacts()->create([
    'contact' => [
        'email' => '[email protected]',
        'firstName' => 'John',
        'lastName' => 'Doe',
        'phone' => '+1234567890',
    ],
]);

// Get, update, delete
$contact = $api->contacts()->get(123);
$contact = $api->contacts()->update(123, ['contact' => ['firstName' => 'Jane']]);
$api->contacts()->delete(123);

// List, search and filter
$contacts = $api->contacts()->list(['email' => '[email protected]', 'limit' => 20, 'offset' => 0]);

// Sync (create or update by email)
$contact = $api->contacts()->sync(['contact' => ['email' => '[email protected]', 'firstName' => 'John']]);

// Tags, lists and automations
$api->contacts()->addTag(123, $tagId);
$api->contacts()->removeTagById(123, $tagId);
$api->contacts()->updateListStatus(123, $listId, 1); // 1 = subscribe, 2 = unsubscribe
$api->contacts()->addToAutomation(123, $automationId);

// Custom field values
$api->contacts()->updateCustomFieldValue(['fieldValue' => ['contact' => 123, 'field' => 5, 'value' => 'Gold']]);
$values = $api->contacts()->getCustomFieldValues(123);

// Bulk import (up to 250 contacts per call, processed asynchronously)
$batch = $api->contacts()->bulkImport(['contacts' => [['email' => '[email protected]'], ['email' => '[email protected]']]]);
$status = $api->contacts()->getBulkImportStatus($batch['batchId']);

// Pipelines and stages are needed to create a deal
$pipelines = $api->deals()->listPipelines();
$stages = $api->deals()->listStages(['filters[d_groupid]' => 1]);

$deal = $api->deals()->create([
    'deal' => [
        'title' => 'New Website Project',
        'value' => 500000, // Value in cents
        'currency' => 'usd',
        'group' => 1,      // Pipeline ID
        'stage' => 1,      // Stage ID
        'owner' => 1,      // User ID
        'contact' => 123,  // Contact ID
    ],
]);

$note = $api->deals()->createNote(456, ['note' => ['note' => 'Initial client meeting went well']]);
$task = $api->deals()->createTask(['dealTask' => ['relid' => 456, 'duedate' => '2026-11-01T10:00:00Z', 'dealTasktype' => 1]]);
$api->deals()->createCustomFieldValue(['dealCustomFieldDatum' => ['dealId' => 456, 'customFieldId' => 2, 'fieldValue' => 'Enterprise']]);

$account = $api->accounts()->create(['account' => ['name' => 'Acme Inc.']]);
$api->accounts()->addContact($account['account']['id'], 123, ['jobTitle' => 'CTO']);

$record = $api->customObjects()->createOrUpdateRecord('schema-id', [
    'record' => ['externalId' => 'order-1', 'fields' => [['id' => 'total', 'value' => 99]]],
]);
$record = $api->customObjects()->getRecordByExternalId('schema-id', 'order-1');

$field = $api->customFields()->create(['field' => ['title' => 'Tier', 'type' => 'dropdown']]);
$tag = $api->tags()->create(['tag' => ['tag' => 'VIP', 'tagType' => 'contact']]);
$lists = $api->lists()->list();
$webhook = $api->webhooks()->create(['webhook' => ['name' => 'Sync', 'url' => 'https://example.com/hook', 'events' => ['subscribe'], 'sources' => ['public']]]);
$me = $api->users()->me(); // handy to verify credentials

use xdubois\ActiveCampaign\Exceptions\ActiveCampaignException;
use xdubois\ActiveCampaign\Exceptions\AuthenticationException;
use xdubois\ActiveCampaign\Exceptions\NotFoundException;
use xdubois\ActiveCampaign\Exceptions\RateLimitException;
use xdubois\ActiveCampaign\Exceptions\ValidationException;

try {
    $contact = $api->contacts()->create($data);
} catch (AuthenticationException $e) {
    // 401/403
} catch (ValidationException $e) {
    // 422
    $errors = $e->getValidationErrors(); // [['title' => ..., 'detail' => ..., 'code' => ..., 'source' => ['pointer' => ...]], ...]
} catch (RateLimitException $e) {
    // 429, after the configured retries were exhausted
    $seconds = $e->getRetryAfter();
} catch (NotFoundException $e) {
    // 404
} catch (ActiveCampaignException $e) {
    // Server errors (5xx), network errors (status code null) and everything else
    $status = $e->getStatusCode();
    $body = $e->getResponseBody();
    $context = $e->getContext(); // status_code, method, uri, response_body, error_data, exception
}