Contents

= campaign_monitor

This RubyGem provides access to the Campaign Monitor API (http://www.campaignmonitor.com/api).

Campaign Monitor recently made some changes to their API.

This fork makes the following changes:

    * host changed from http://app.campaignmonitor.com to http://api.createsend.com
    * 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


== Pre-requisites

An account with Campaign Monitor and the API Key. Accounts are free and can be created at
http://www.campaignmonitor.com.

== Resources

=== Install
gem install turingstudio-campaign_monitor

=== Git Repository
http://github.com/turingstudio/campaign-monitor-ruby


== Usage

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

  for client in cm.clients
    for list in client.lists
      client.name # => returns the name
    
      # modify a subscriber list
      list.add_subscriber(email, name, custom_fields_hash)
      list.remove_subscriber(email)
      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)
    end
  
    for campaign in client.campaigns
  
    end
  end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
turingstudio-campaign_monitor-1.3.1	README.rdoc