Mailchimp Marketing — Ruby

The official Ruby client library for the Mailchimp Marketing API

Installation

via RubyGems

gem install MailchimpMarketing

via Git

gem 'MailchimpMarketing', :git => 'https://github.com/mailchimp/mailchimp-marketing-ruby.git'

via Local Installation

gem build MailchimpMarketing.gemspec
gem install ./MailchimpMarketing-3.0.74.gem
gem 'MailchimpMarketing', '~> 3.0.74'

Quick Start

require 'MailchimpMarketing'

begin
  client = MailchimpMarketing::Client.new()
  client.set_config({
    :api_key => 'YOUR_API_KEY',
    :server => 'YOUR_SERVER_PREFIX'
  })
  result = client.ping.get()
  p result
rescue MailchimpMarketing::ApiError => e
  puts "Error: #{e}"
end

Authentication Methods

The client library can be configured to use either Basic Auth or OAuth2. A server prefix should be provided i.e. us19, in order for the client to determine to appropriate host url.

Basic Auth

client.set_config({
  :api_key => 'YOUR_API_KEY',
  :server => 'YOUR_SERVER_PREFIX'
})

OAuth2

client.set_config({
  :access_token => 'YOUR_ACCESS_TOKEN',
  :server => 'YOUR_SERVER_PREFIX'
})

Shorthand

As a shortcut, the configuration object can be passed in directly when creating the client.

client = MailchimpMarketing::Client.new({
  :api_key => 'YOUR_API_KEY',
  :server => 'YOUR_SERVER_PREFIX'
})

PRs and Issues

This repo is autogenerated from https://github.com/mailchimp/mailchimp-client-lib-codegen -- please submit PRs or issues there!

API Endpoints

All URIs are relative to https://server.api.mailchimp.com/3.0

Additional Libraries

Mailchimp Marketing libraries are available in the following languages: