Skip to Content

Campaigner

Sync contacts and manage mailing list membership in Campaigner for email marketing campaigns. Zeotap keeps your Campaigner subscriber lists in sync with your warehouse data, enabling targeted email campaigns with up-to-date contact attributes.

Prerequisites

  • A Campaigner account with API access
  • A Campaigner API key (generated from an API user)

Authentication

Campaigner uses API Key authentication.

  1. In Campaigner, go to Account Settings > Users
  2. Click Create New User and set the User Role to API User
  3. Click Save to create the user
  4. Navigate to the user’s API Keys tab and copy the API key
  5. Paste the API key into the API Key field in Zeotap

Configuration

No additional configuration fields are required for Campaigner. Authentication is handled entirely through the API key.

Target Settings

FieldTypeRequiredDescription
Mailing List IDTextNoCampaigner mailing list ID to manage subscriber membership. Required for audience syncs.

To find your Mailing List ID, navigate to Lists in Campaigner. The ID is displayed in the list details or URL when viewing a specific list.

Supported Operations

Sync Modes

ModeSupported
UpsertYes
Insert
UpdateYes

Audience Sync Modes

ModeSupported
AddYes
RemoveYes
MirrorYes
UpsertYes

Features

  • Field Mapping: Yes
  • Schema Introspection: No

Required Mapping Fields

FieldDescription
emailSubscriber email address (primary identifier)

Default Destination Fields

email, FirstName, LastName, CustomField1, CustomField2

Campaigner uses PascalCase for custom field names (e.g., FirstName, LastName). Zeotap automatically maps common field names to Campaigner’s expected format when syncing.

How It Works

Contact Sync (Upsert Mode)

  1. Zeotap sends each subscriber to the Campaigner Subscribers endpoint (POST /v1/Subscribers at https://edapi.campaigner.com)
  2. Existing subscribers matched by email address are updated; new subscribers are created
  3. If a Mailing List ID is configured, the subscriber is attached to that list in the same request via the Lists array

Audience Sync (Add/Remove/Mirror)

  • Add / Upsert: Subscribers are created or updated via POST /v1/Subscribers with the mailing list included in the Lists array
  • Remove: Subscribers are removed from the mailing list via DELETE /v1/Lists/{listId}/Subscribers/{email}
  • Mirror: Added/changed subscribers are upserted and attached to the list; removed subscribers are unsubscribed from the list

Update Mode

Existing subscribers are updated individually via PUT /v1/Subscribers. Subscribers that do not exist in Campaigner will return an error.

Rate Limits

Campaigner applies rate limits on API requests. Zeotap automatically retries on 429 Too Many Requests responses with exponential backoff and respects Retry-After headers.

Best Practices

  • Use upsert mode for most contact syncs to avoid errors when subscribers already exist
  • Configure a Mailing List ID for audience syncs to manage list membership automatically
  • Use PascalCase field names where possible, matching Campaigner’s convention (e.g., FirstName, LastName)
  • Map the email field as it is the primary identifier for all subscriber operations
  • Keep syncs reasonable — Zeotap batches list membership operations to stay within Campaigner’s limits

Troubleshooting

Authentication failed: invalid API key

Ensure your API key was generated from an API User account. Navigate to Account Settings > Users, select your API user, and verify the key under the API Keys tab. Generate a new key if needed.

Subscriber not found (update mode)

The update sync mode requires that subscribers already exist in Campaigner. If you are syncing new subscribers, use upsert mode instead.

Mailing List ID not found

Verify the Mailing List ID exists by navigating to Lists in Campaigner. The ID is visible in the list details or URL when viewing a specific list.

Custom fields not syncing

Ensure that custom field names in your mapping match the field names configured in your Campaigner account. Campaigner uses PascalCase naming convention for fields.

Remove mode requires a list ID

The remove audience sync mode requires a Mailing List ID to be configured in the target settings. Without a list ID, Zeotap cannot determine which list to remove subscribers from.

Rate limit exceeded (429 errors)

Zeotap retries automatically with exponential backoff. If errors persist, consider spacing out your sync schedule or contacting Campaigner support for rate limit increases.

Last updated on