No commit activity in last 3 years
Ruby gem for accessing the Campaign Monitor API
 Project Readme

campaign_monitor¶ ↑

This RubyGem provides access to the Campaign Monitor API (

Campaign Monitor recently made some changes to their API.

patientslikeme's fork makes the following changes:

* host changed from to
* ID values are no longer sent #to_i because they are hex strings
* added support for subscribers with custom fields using SOAP API
* refactored gemspec to build on github
* misc. cleanup and refactoring

This fork integrates the following additional changes:

* updates Subscriber#is_subscribed? to work with the latest API. (from amiel)
* adds support for array values in custom_field_hash (from oferlin)
* API key cleanup (from yyyc514)
* added ability to get fetch lists by id using List#GetDetails or List#[] (from yyyc514)
* added support for adding and deleting clients (from yyyc514)
* added support for querying CM for countries and timezones (from yyyc514)
* added support for creating campaigns (from yyyc514)
* general test and api cleanup (from yyyc514)

Pre-requisites¶ ↑

An account with Campaign Monitor and the API Key. Accounts are free and can be created at

Resources¶ ↑

Install¶ ↑

gem install patientslikeme-campaign_monitor

Git Repository¶ ↑

Usage¶ ↑

cm = # assumes you've set CAMPAIGN_MONITOR_API_KEY in your project

for client in cm.clients
  for list in client.lists # => returns the name

    # modify a subscriber list
    list.add_subscriber(email, name, custom_fields_hash)
    list.add_and_resubscribe(email, name, custom_fields_hash)

    # get subscriber list details
    subscribers = list.active_subscribers(since_time)
    unsubscribed = list.unsubscribed(since_time)
    bounced = list.bounced(since_time)

  for campaign in client.campaigns