convertkit.cr

convertkit.cr is a Crystal API Client for the ConvertKit API

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     convertkit:
       github: hostari/convertkit.cr
   

2. Run shards install

Usage

require "convertkit"

# Set your API secret
ConvertKit.api_secret = "api-secret-here"

# Retrieving subscribers
subscribers = ConvertKit::Subscribers.retrieve.subscribers

# Iterate through each subscriber
subscribers.each do |subscriber|
  puts subscriber
end

# Creating a Tag
ConvertKit::Tags.create({name: "Email Newsletter"})

API endpoints

Note that the plural form of the resource is used when retrieving a list (i.e. Subscribers.retrieve) and singular form when retrieving a specific item of a resource i.e. Subscriber.retrieve(id)

Contributing

1. Fork it (https://github.com/your-github-user/convertkit/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• jcads - creator and maintainer